doxygenify

This commit is contained in:
Jim O'Regan 2015-05-14 15:17:21 +01:00
parent 2a36a3edec
commit 229d218445
2 changed files with 18 additions and 26 deletions

View File

@ -15,44 +15,36 @@
** See the License for the specific language governing permissions and ** See the License for the specific language governing permissions and
** limitations under the License. ** limitations under the License.
******************************************************************************/ ******************************************************************************/
/**---------------------------------------------------------------------------- /*----------------------------------------------------------------------------
Include Files and Type Defines Include Files and Type Defines
----------------------------------------------------------------------------**/ ----------------------------------------------------------------------------**/
#include "mfdefs.h" #include "mfdefs.h"
#include "emalloc.h" #include "emalloc.h"
#include <math.h> #include <math.h>
/**---------------------------------------------------------------------------- /*----------------------------------------------------------------------------
Public Code Public Code
----------------------------------------------------------------------------**/ ----------------------------------------------------------------------------**/
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
MICROFEATURE NewMicroFeature() { /**
/* * This routine allocates and returns a new micro-feature
** Parameters: none * data structure.
** Globals: none * @return New MICROFEATURE
** Operation: * @note History: 7/27/89, DSJ, Created.
** This routine allocates and returns a new micro-feature
** data structure.
** Return: New micro-feature.
** Exceptions: none
** History: 7/27/89, DSJ, Created.
*/ */
MICROFEATURE NewMicroFeature() {
return ((MICROFEATURE) Emalloc (sizeof (MFBLOCK))); return ((MICROFEATURE) Emalloc (sizeof (MFBLOCK)));
} /* NewMicroFeature */ } /* NewMicroFeature */
/*---------------------------------------------------------------------------*/ /*---------------------------------------------------------------------------*/
void FreeMicroFeatures(MICROFEATURES MicroFeatures) { /**
/* * This routine deallocates all of the memory consumed by
** Parameters: * a list of micro-features.
** MicroFeatures list of micro-features to be freed * @param MicroFeatures list of micro-features to be freed
** Globals: none * @return none
** Operation: * @note History: 7/27/89, DSJ, Created.
** This routine deallocates all of the memory consumed by
** a list of micro-features.
** Return: none
** Exceptions: none
** History: 7/27/89, DSJ, Created.
*/ */
void FreeMicroFeatures(MICROFEATURES MicroFeatures) {
destroy_nodes(MicroFeatures, Efree); destroy_nodes(MicroFeatures, Efree);
} /* FreeMicroFeatures */ } /* FreeMicroFeatures */

View File

@ -18,11 +18,11 @@
#ifndef MFX_H #ifndef MFX_H
#define MFX_H #define MFX_H
/**---------------------------------------------------------------------------- /*----------------------------------------------------------------------------
Include Files and Type Defines Include Files and Type Defines
----------------------------------------------------------------------------**/ ----------------------------------------------------------------------------**/
#include "params.h" #include "params.h"
/**---------------------------------------------------------------------------- /*----------------------------------------------------------------------------
Variables Variables
----------------------------------------------------------------------------**/ ----------------------------------------------------------------------------**/
@ -32,7 +32,7 @@ extern double_VAR_H(classify_min_slope, 0.414213562,
extern double_VAR_H(classify_max_slope, 2.414213562, extern double_VAR_H(classify_max_slope, 2.414213562,
"Slope above which lines are called vertical"); "Slope above which lines are called vertical");
/**---------------------------------------------------------------------------- /*----------------------------------------------------------------------------
Public Function Prototypes Public Function Prototypes
----------------------------------------------------------------------------**/ ----------------------------------------------------------------------------**/
CHAR_FEATURES BlobMicroFeatures(TBLOB *Blob, const DENORM& bl_denorm, CHAR_FEATURES BlobMicroFeatures(TBLOB *Blob, const DENORM& bl_denorm,