From 47453d9b8fb42be6ff4bed00d82ed2de6e0b01ff Mon Sep 17 00:00:00 2001 From: bert Date: Sat, 26 Nov 2016 20:41:59 +0100 Subject: [PATCH] src/vector.[ch]: Converted plain comments into doxygen comments. Signed-off-by: bert --- src/vector.c | 12 ++++++++++ src/vector.h | 78 +++++++++++++++++++++++++++++------------------------------- 2 files changed, 50 insertions(+), 40 deletions(-) diff --git a/src/vector.c b/src/vector.c index c17d8d13ca..b8e355e49d 100644 --- a/src/vector.c +++ b/src/vector.c @@ -171,18 +171,27 @@ vector_append (vector_t * vector, vector_element_t data) vector_insert_many (vector, vector->size, &data, 1); } +/*! + * \brief Add multiple elements to end of vector. + */ void vector_append_many (vector_t * vector, vector_element_t data[], int count) { vector_insert_many (vector, vector->size, data, count); } +/*! + * \brief Add a vector of elements to the end of vector. + */ void vector_append_vector (vector_t * vector, vector_t * other_vector) { vector_append_many (vector, other_vector->element, other_vector->size); } +/*! + * \brief Add data at specified position of vector. + */ void vector_insert (vector_t * vector, int N, vector_element_t data) { @@ -214,6 +223,9 @@ vector_insert_many (vector_t * vector, int N, assert (__vector_is_good (vector)); } +/*! + * \brief Copy a vector. + */ vector_t * vector_duplicate (vector_t * orig) { diff --git a/src/vector.h b/src/vector.h index b6b6de1ace..163de6dbb1 100644 --- a/src/vector.h +++ b/src/vector.h @@ -1,50 +1,57 @@ -/* - * COPYRIGHT +/*! + * \file src/vector.h * - * PCB, interactive printed circuit board design - * Copyright (C) 1994,1995,1996 Thomas Nau - * Copyright (C) 1998,1999,2000,2001 harry eaton + * \brief Prototypes for vectors routines. * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. + * \author this file, vector.c, was written and is + * Copyright (c) 2001 C. Scott Ananian. * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. + *
* - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + *

Copyright.

\n * - * Contact addresses for paper mail and Email: - * harry eaton, 6697 Buttonhole Ct, Columbia, MD 21044 USA - * haceaton@aplcomm.jhuapl.edu + * PCB, interactive printed circuit board design * - */ - -/* this file, vector.h, was written and is - * Copyright (c) 2001 C. Scott Ananian. - */ - -/* prototypes for vector routines. + * Copyright (C) 1994,1995,1996 Thomas Nau + * + * Copyright (C) 1998,1999,2000,2001 harry eaton + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + * + * Contact addresses for paper mail and Email: + * + * harry eaton, 6697 Buttonhole Ct, Columbia, MD 21044 USA + * + * haceaton@aplcomm.jhuapl.edu */ #ifndef PCB_VECTOR_H #define PCB_VECTOR_H -/* what a vector looks like */ +/*! + * \brief What a vector looks like. + */ typedef struct vector_struct vector_t; -/* what data in a vector looks like */ + +/*! + * \brief What data in a vector looks like. + */ typedef void *vector_element_t; -/* create an empty vector */ vector_t *vector_create (); -/* destroy a vector */ void vector_destroy (vector_t ** vector); -/* copy a vector */ vector_t *vector_duplicate (vector_t * vector); /* -- interrogation -- */ @@ -55,24 +62,15 @@ vector_element_t vector_element_first (vector_t * vector); vector_element_t vector_element_last (vector_t * vector); /* -- mutation -- */ -/* add data to end of vector */ void vector_append (vector_t * vector, vector_element_t data); -/* add multiple elements to end of vector */ void vector_append_many (vector_t * vector, vector_element_t data[], int count); -/* add a vector of elements to the end of vector */ void vector_append_vector (vector_t * vector, vector_t * other_vector); -/* add data at specified position of vector */ void vector_insert (vector_t * vector, int N, vector_element_t data); -/* add multiple elements at specified position of vector */ void vector_insert_many (vector_t * vector, int N, vector_element_t data[], int count); -/* return and delete the *last* element of vector */ vector_element_t vector_remove_last (vector_t * vector); -/* return and delete data at specified position of vector */ vector_element_t vector_remove (vector_t * vector, int N); -/* replace the data at the specified position with the given data. - * returns the old data. */ vector_element_t vector_replace (vector_t * vector, vector_element_t data, int N); -- 2.11.4.GIT