From 39fd21b04b9d251046a709cff8e4bbb9c27b89f5 Mon Sep 17 00:00:00 2001 From: Holger Vogt Date: Wed, 12 Oct 2022 21:33:24 +0200 Subject: [PATCH] Update to comments for doxygen --- src/maths/cmaths/cmath.h | 4 ++++ src/maths/cmaths/cmath1.c | 12 ------------ src/maths/cmaths/cmath1.h | 8 ++++++-- src/maths/cmaths/cmath2.c | 11 ----------- src/maths/cmaths/cmath2.h | 6 +++++- src/maths/cmaths/cmath3.c | 11 ----------- src/maths/cmaths/cmath3.h | 6 +++++- src/maths/cmaths/cmath4.c | 11 ----------- src/maths/cmaths/cmath4.h | 6 +++++- 9 files changed, 25 insertions(+), 50 deletions(-) diff --git a/src/maths/cmaths/cmath.h b/src/maths/cmaths/cmath.h index 96189f077..01642684b 100644 --- a/src/maths/cmaths/cmath.h +++ b/src/maths/cmaths/cmath.h @@ -1,3 +1,7 @@ +/** \file cmath.h + \brief Header file for cmath*.c +*/ + #ifndef ngspice_CMATH_H #define ngspice_CMATH_H diff --git a/src/maths/cmaths/cmath1.c b/src/maths/cmaths/cmath1.c index 3d08c2626..416c934a6 100644 --- a/src/maths/cmaths/cmath1.c +++ b/src/maths/cmaths/cmath1.c @@ -17,18 +17,6 @@ Author: 1985 Wayne A. Christopher, U. C. Berkeley CAD Group and return a char * that is cast to complex or double. */ -/* - * Routines to do complex mathematical functions. These routines require - * the -lm libraries. We sacrifice a lot of space to be able - * to avoid having to do a seperate call for every vector element, - * but it pays off in time savings. These routines should never - * allow FPE's to happen. - * - * Complex functions are called as follows: - * cx_something(data, type, length, &newlength, &newtype), - * and return a char * that is cast to complex or double. - * - */ #include diff --git a/src/maths/cmaths/cmath1.h b/src/maths/cmaths/cmath1.h index f13587d67..24671f60a 100644 --- a/src/maths/cmaths/cmath1.h +++ b/src/maths/cmaths/cmath1.h @@ -1,8 +1,12 @@ /************* - * Header file for cmath1.c - * 1999 E. Rouat + * 1999 E. Rouat + * 3-Clause BSD ************/ + /** \file cmath1.h + \brief Header file for cmath1.c, function prototypes + */ + #ifndef ngspice_CMATH1_H #define ngspice_CMATH1_H diff --git a/src/maths/cmaths/cmath2.c b/src/maths/cmaths/cmath2.c index 090de0589..e5f09f67c 100644 --- a/src/maths/cmaths/cmath2.c +++ b/src/maths/cmaths/cmath2.c @@ -17,17 +17,6 @@ Author: 1985 Wayne A. Christopher, U. C. Berkeley CAD Group and return a char * that is cast to complex or double. */ -/* - * Routines to do complex mathematical functions. These routines require - * the -lm libraries. We sacrifice a lot of space to be able - * to avoid having to do a seperate call for every vector element, - * but it pays off in time savings. These routines should never - * allow FPE's to happen. - * - * Complex functions are called as follows: - * cx_something(data, type, length, &newlength, &newtype), - * and return a char * that is cast to complex or double. - */ #include "ngspice/ngspice.h" #include "ngspice/cpdefs.h" diff --git a/src/maths/cmaths/cmath2.h b/src/maths/cmaths/cmath2.h index 54df8bbee..897518721 100644 --- a/src/maths/cmaths/cmath2.h +++ b/src/maths/cmaths/cmath2.h @@ -1,8 +1,12 @@ /************* - * Header file for cmath2.c * 1999 E. Rouat + * 3-Clause BSD ************/ + /** \file cmath2.h + \brief Header file for cmath2.c, function prototypes + */ + #ifndef ngspice_CMATH2_H #define ngspice_CMATH2_H diff --git a/src/maths/cmaths/cmath3.c b/src/maths/cmaths/cmath3.c index 2f688b1d0..d5d0f6e89 100644 --- a/src/maths/cmaths/cmath3.c +++ b/src/maths/cmaths/cmath3.c @@ -17,17 +17,6 @@ Author: 1985 Wayne A. Christopher, U. C. Berkeley CAD Group and return a char * that is cast to complex or double. */ -/* - * Routines to do complex mathematical functions. These routines require - * the -lm libraries. We sacrifice a lot of space to be able - * to avoid having to do a seperate call for every vector element, - * but it pays off in time savings. These routines should never - * allow FPE's to happen. - * - * Complex functions are called as follows: - * cx_something(data, type, length, &newlength, &newtype), - * and return a char * that is cast to complex or double. - */ #include "ngspice/ngspice.h" #include "ngspice/cpdefs.h" diff --git a/src/maths/cmaths/cmath3.h b/src/maths/cmaths/cmath3.h index 4cb2eefcc..7e93659b0 100644 --- a/src/maths/cmaths/cmath3.h +++ b/src/maths/cmaths/cmath3.h @@ -1,8 +1,12 @@ /************* - * Header file for cmath3.c * 1999 E. Rouat + * 3-Clause BSD ************/ + /** \file cmath3.h + \brief Header file for cmath3.c, function prototypes + */ + #ifndef ngspice_CMATH3_H #define ngspice_CMATH3_H diff --git a/src/maths/cmaths/cmath4.c b/src/maths/cmaths/cmath4.c index 20e233d86..fb428f5f2 100644 --- a/src/maths/cmaths/cmath4.c +++ b/src/maths/cmaths/cmath4.c @@ -17,17 +17,6 @@ Author: 1985 Wayne A. Christopher, U. C. Berkeley CAD Group and return a char * that is cast to complex or double. */ -/* - * Routines to do complex mathematical functions. These routines require - * the -lm libraries. We sacrifice a lot of space to be able - * to avoid having to do a seperate call for every vector element, - * but it pays off in time savings. These routines should never - * allow FPE's to happen. - * - * Complex functions are called as follows: - * cx_something(data, type, length, &newlength, &newtype), - * and return a char * that is cast to complex or double. - */ #include "ngspice/ngspice.h" #include "ngspice/plot.h" diff --git a/src/maths/cmaths/cmath4.h b/src/maths/cmaths/cmath4.h index 82f9e6179..5b52f90b2 100644 --- a/src/maths/cmaths/cmath4.h +++ b/src/maths/cmaths/cmath4.h @@ -1,8 +1,12 @@ /************* - * Header file for cmath4.c * 1999 E. Rouat + * 3-Clause BSD ************/ + /** \file cmath4.h + \brief Header file for cmath4.c, function prototypes + */ + #ifndef ngspice_CMATH4_H #define ngspice_CMATH4_H