Changeset 11253 for trunk/psModules/src/extras

Timestamp:

Jan 23, 2007, 4:54:15 PM (20 years ago)

Author:

magnier

Message:

cleaned up Doxygen groups

Location:

trunk/psModules/src/extras

Files:

• pmKapaPlots.c (modified) (2 diffs)
• pmKapaPlots.h (modified) (2 diffs)
• psIOBuffer.h (modified) (2 diffs)
• psPipe.h (modified) (2 diffs)
• psVectorBracket.h (modified) (2 diffs)

trunk/psModules/src/extras/pmKapaPlots.c

@@ -7 +7 @@
  *  @author EAM, IfA
  *
- *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2007-01-01 21:03:41 $
+ *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2007-01-24 02:54:15 $
  *
  *  Copyright 2006 Institute for Astronomy, University of Hawaii
@@ -148 +148 @@
     # include "pmKapaPlots.h"
 
-    int pmKapaOpen ()
+    int pmKapaOpen (bool showWindow)
 {
     return -1;

trunk/psModules/src/extras/pmKapaPlots.h

@@ -1 @@
-/** @file  pmKapaPlots.h
-*
-*  @brief functions to make plots with the external program 'kapa' 
-*
-*  @ingroup extras
-*
-*  @author EAM, IfA
-*
-*  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2007-01-01 21:03:41 $
-*
-*  Copyright 2006 Institute for Astronomy, University of Hawaii
-*/
+/* @file  pmKapaPlots.h
+ * @brief functions to make plots with the external program 'kapa' 
+ *
+ * @author EAM, IfA
+ *
+ * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
+ * @date $Date: 2007-01-24 02:54:15 $
+ * Copyright 2006 Institute for Astronomy, University of Hawaii
+ */
 
 #ifndef PM_KAPA_PLOTS_H
 #define PM_KAPA_PLOTS_H
+
+/// @addtogroup Extras Miscellaneous Funtions
+/// @{
 
 // move to psLib or psModules
@@ -31 +30 @@
 # endif
 
+/// @}
 #endif // PM_KAPA_PLOTS_H

trunk/psModules/src/extras/psIOBuffer.h

@@ -1 @@
-/** @file  psPipe.h
-*
-*  @brief 3-stream pipe 
-*
-*  @ingroup misc
-*
-*  @author EAM, IfA
-*
-*  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2006-12-10 18:27:26 $
-*
-*  Copyright 2004-2005 Institute for Astronomy, University of Hawaii
-*/
+/* @file  IOBuffer.h
+ * @brief input/output character buffer
+ *
+ * @author EAM, IfA
+ *
+ * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
+ * @date $Date: 2007-01-24 02:54:15 $
+ * Copyright 2004-2005 Institute for Astronomy, University of Hawaii
+ */
 
 #ifndef PS_IO_BUFFER_H
 #define PS_IO_BUFFER_H
+
+/// @addtogroup Extras Miscellaneous Funtions
+/// @{
 
 typedef struct
@@ -32 +31 @@
 int psIOBufferReadEmpty (psIOBuffer *buffer, int maxRetries, int fd);
 
+/// @}
 # endif

trunk/psModules/src/extras/psPipe.h

@@ -1 @@
-/** @file  psPipe.h
-*
-*  @brief 3-stream pipe 
-*
-*  @ingroup misc
-*
-*  @author EAM, IfA
-*
-*  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2006-12-10 18:27:26 $
-*
-*  Copyright 2004-2005 Institute for Astronomy, University of Hawaii
-*/
+/* @file  psPipe.h
+ * @brief 3-stream pipe 
+ *
+ * @author EAM, IfA
+ *
+ * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
+ * @date $Date: 2007-01-24 02:54:15 $
+ * Copyright 2004-2005 Institute for Astronomy, University of Hawaii
+ */
 
 #ifndef PS_PIPE_H
 #define PS_PIPE_H
+
+/// @addtogroup Extras Miscellaneous Funtions
+/// @{
 
 // move these to pslib??
@@ -31 +30 @@
 int     psPipeClose (psPipe *pipe);
 
+/// @}
 # endif

trunk/psModules/src/extras/psVectorBracket.h

@@ +1 @@
+/* @file  psVectorBracket.h
+ * @brief vector bracket functions
+ *
+ * @author EAM, IfA
+ *
+ * @version $Revision: 1.2 $ $Name: not supported by cvs2svn $
+ * @date $Date: 2007-01-24 02:54:15 $
+ * Copyright 2004-2005 Institute for Astronomy, University of Hawaii
+ */
 
 # ifndef PS_VECTOR_BRACKET_H
 # define PS_VECTOR_BRACKET_H
+
+/// @addtogroup Extras Miscellaneous Funtions
+/// @{
 
 int psVectorBracket(const psVector *index, psF32 key, bool above);
@@ -7 +19 @@
 psF32 psVectorInterpolate(const psVector *index, const psVector *value, psF32 key);
 
+/// @}
 # endif /* PS_VECTOR_BRACKET_H */