Changeset 14476


Ignore:
Timestamp:
03/28/13 15:54:06 (12 years ago)
Author:
cborstad
Message:

CHG: updated code comments for doxygen doc

Location:
issm/trunk-jpl/src/c/Container
Files:
24 edited

Legend:

Unmodified
Added
Removed

  • issm/trunk-jpl/src/c/Container/Constraints.cpp

    r13622 r14476  
    11/*
    2  * \file Constraints.c
    3  * \brief: implementation of the Constraints class, derived from DataSet class
     2 * \file Constraints.cpp
     3 * \brief: Implementation of Constraints class, derived from DataSet class.
    44 */
    55

  • issm/trunk-jpl/src/c/Container/Constraints.h

    r13797 r14476  
    1 /*!\file: Constraints.h
    2  * \brief prototypes for Constraints.h
    3  */
    4 
    51#ifndef _CONTAINER_CONSTRAINTS_H_
    62#define  _CONTAINER_CONSTRAINTS_H_
    … …  
    1612class Inputs;
    1713
     14/*! \brief Declaration of Constraints class.
     15 *
     16 * Declaration of Constraints class for handling Single Point Constraints (SPCs).
     17 * Constraints are vector lists (Containers) of Constraint objects.
     18 */
    1819class Constraints: public DataSet{
    1920

  • issm/trunk-jpl/src/c/Container/Container.h

    r12466 r14476  
    11/*!\file: Container.h
    2  * \brief prototypes for all containers used in ISSM
     2 * \brief Prototypes for all Containers (vector lists of objects) used in ISSM
    33 */
    44

  • issm/trunk-jpl/src/c/Container/DataSet.cpp

    r14238 r14476  
    11/*
    2  * \file DataSet.c
    3  * \brief: implementation of the DataSet class, and derived classes Inputs and Parameters
     2 * \file DataSet.cpp
     3 * \brief: Implementation of DataSet class
    44 */
    55

  • issm/trunk-jpl/src/c/Container/DataSet.h

    r13797 r14476  
    1 /*
    2  * DataSet.h: declaration of DataSet,Parameters and Inputs classes
    3  */
    4 
    51#ifndef _CONTAINER_DATASET_H_
    62#define _CONTAINER_DATASET_H_
    … …  
    2218class Patch;
    2319
     20/*! \brief Declaration of DataSet class
     21 *
     22 * Declaration of DataSet class.  A DataSet is a Container of Objects.
     23 */
    2424class DataSet{
    2525

  • issm/trunk-jpl/src/c/Container/Elements.cpp

    r13887 r14476  
    11/*
    2  * \file Elements.c
    3  * \brief: implementation of the Elements class, derived from DataSet class
     2 * \file Elements.cpp
     3 * \brief: Implementation of Elements class, derived from DataSet class
    44 */
    55

  • issm/trunk-jpl/src/c/Container/Elements.h

    r13887 r14476  
    1 /*!\file: Elements.h
    2  * \brief prototypes for Elements.h
    3  */
    4 
    51#ifndef _CONTAINER_ELEMENTS_H_
    62#define  _CONTAINER_ELEMENTS_H_
    … …  
    1612class Inputs;
    1713
     14/*! \brief Declaration of Elements class
     15 *
     16 * Declaration of Elements class.  Elements are vector lists (Containers) of Element objects.
     17 */
    1818class Elements: public DataSet{
    1919

  • issm/trunk-jpl/src/c/Container/Inputs.h

    r13797 r14476  
    1 /*!\file: Inputs.h
    2  * \brief prototypes for Inputs.h
    3  */
    4 
    51#ifndef _CONTAINER_INPUTS_H_
    62#define  _CONTAINER_INPUTS_H_
    … …  
    1915class GaussPenta;
    2016
     17/*! \brief Declaration of Inputs class.
     18 *
     19 * Declaration of Inputs class.  Inputs are vector lists (Containers) of Input objects.
     20 */
    2121class Inputs: public DataSet{
    2222

  • issm/trunk-jpl/src/c/Container/Loads.cpp

    r13925 r14476  
    11/*
    2  * \file Loads.c
    3  * \brief: implementation of the Loads class, derived from DataSet class
     2 * \file Loads.cpp
     3 * \brief: Implementation of Loads class, derived from DataSet class.
    44 */
    55

  • issm/trunk-jpl/src/c/Container/Loads.h

    r13925 r14476  
    1 /*!\file: Loads.h
    2  * \brief prototypes for Loads.h
    3  */
    4 
    51#ifndef _CONTAINER_LOADS_H_
    62#define  _CONTAINER_LOADS_H_
    … …  
    1612class Inputs;
    1713
     14/*!\brief Declaration of Loads class.
     15 *
     16 * Declaration of Loads class.  Loads are vector lists (Containers) of Load objects.
     17 */
    1818class Loads: public DataSet{
    1919

  • issm/trunk-jpl/src/c/Container/Materials.cpp

    r13797 r14476  
    11/*
    2  * \file Materials.c
    3  * \brief: implementation of the Materials class, derived from DataSet class
     2 * \file Materials.cpp
     3 * \brief: Implementation of Materials class, derived from DataSet class.
    44 */
    55

  • issm/trunk-jpl/src/c/Container/Materials.h

    r13797 r14476  
    1 /*!\file: Materials.h
    2  * \brief prototypes for Materials.h
    3  */
    4 
    51#ifndef _CONTAINER_MATERIALS_H_
    62#define  _CONTAINER_MATERIALS_H_
    … …  
    1511class Inputs;
    1612
     13/*! \brief Declaration of Materials class.
     14 *
     15 * Declaration of Materials class.  Materials are vector lists (Containers) of Material objects.
     16 */
    1717class Materials: public DataSet{
    1818

  • issm/trunk-jpl/src/c/Container/Nodes.cpp

    r13907 r14476  
    11/*
    2  * \file Nodes.c
    3  * \brief: implementation of the Nodes class, derived from DataSet class
     2 * \file Nodes.cpp
     3 * \brief: Implementation of Nodes class, derived from DataSet class.
    44 */
    55

  • issm/trunk-jpl/src/c/Container/Nodes.h

    r13833 r14476  
    1 /*!\file: Nodes.h
    2  * \brief prototypes for Nodes.h
    3  */
    4 
    51#ifndef _CONTAINER_NODES_H_
    62#define  _CONTAINER_NODES_H_
    … …  
    84#include "./DataSet.h"
    95
    10 /*forward declarations */
     6/*!\brief Declaration of Nodes class.
     7 *
     8 * Declaration of Nodes class.  Nodes are vector lists of objects (Containers) of Node objects.
     9 * Node objects are the degrees of freedom (DOFs) for a particular analysis type (not to be
     10 * confused with a vertex, which defines the (x,y,z) location of a point).
     11 */
    1112class Nodes: public DataSet{
    1213

  • issm/trunk-jpl/src/c/Container/Observations.cpp

    r14250 r14476  
    11/*
    2  * \file Observations.c
    3  * \brief: implementation of the Observations class, derived from DataSet class
     2 * \file Observations.cpp
     3 * \brief: Implementation of Observations class, derived from DataSet class.
    44 */
    55

  • issm/trunk-jpl/src/c/Container/Observations.h

    r14226 r14476  
    1 /*!\file: Observations.h
    2  * \brief prototypes for Observations.h
    3  */
    4 
    51#ifndef _CONTAINER_OBSERVATIONS_H_
    62#define  _CONTAINER_OBSERVATIONS_H_
    … …  
    128class Variogram;
    139class Options;
     10
     11/*!\brief Declaration of Observations class.
     12 *
     13 * Declaration of Observations class.  Observations are vector lists (Containers) of Observation objects.
     14 */
    1415
    1516class Observations: public DataSet{

  • issm/trunk-jpl/src/c/Container/Options.cpp

    r13797 r14476  
    11/*
    2  * \file Options.c
    3  * \brief: implementation of the Options class, derived from DataSet class
     2 * \file Options.cpp
     3 * \brief: Implementation of Options class, derived from DataSet class.
    44 */
    55

  • issm/trunk-jpl/src/c/Container/Options.h

    r14052 r14476  
    1 /*!\file: Options.h
    2  * \brief prototypes for Options.h
    3  */
    4 
    51#ifndef _CONTAINER_OPTIONS_H_
    62#define _CONTAINER_OPTIONS_H_
    … …  
    117class Option;
    128
     9/*!\brief Declaration of Options class.
     10 *
     11 * Declaration of Options class.  Options are vector lists (Containers) of Option objects.
     12 */
    1313class Options: public DataSet{
    1414

  • issm/trunk-jpl/src/c/Container/Parameters.cpp

    r13797 r14476  
    11/*
    2  * \file Parameters.c
    3  * \brief: implementation of the Parameters class, derived from DataSet class
     2 * \file Parameters.cpp
     3 * \brief: Implementation of the Parameters class, derived from DataSet class.
    44 */
    55

  • issm/trunk-jpl/src/c/Container/Parameters.h

    r13623 r14476  
    1 /*!\file: Parameters.h
    2  * \brief prototypes for Parameters.h
    3  */
    4 
    51#ifndef _CONTAINER_PARAMETERS_H_
    62#define  _CONTAINER_PARAMETERS_H_
    … …  
    1915class Inputs;
    2016
     17/*!\brief Declaration of Parameters class. 
     18 *
     19 * Declaration of Parameters class.  Parameters are vector lists (Containers) of Parameter objects.
     20 */
    2121class Parameters: public DataSet{
    2222

  • issm/trunk-jpl/src/c/Container/Results.cpp

    r13797 r14476  
    11/*
    2  * \file Results.c
    3  * \brief: implementation of the Results class, derived from DataSet class
     2 * \file Results.cpp
     3 * \brief: Implementation of the Results class, derived from DataSet class.
    44 */
    55

  • issm/trunk-jpl/src/c/Container/Results.h

    r13797 r14476  
    1 /*!\file: Results.h
    2  * \brief prototypes for Results.h
    3  */
    4 
    51#ifndef _CONTAINER_RESULTS_H_
    62#define  _CONTAINER_RESULTS_H_
    … …  
    1612class Inputs;
    1713
     14/*!\brief Declaration of Results class.
     15 *
     16 * Declaration of Results class.  Results are vector lists (Containers) of Result objects.
     17 */
    1818class Results: public DataSet{
    1919

  • issm/trunk-jpl/src/c/Container/Vertices.cpp

    r14100 r14476  
    11/*
    2  * \file Vertices.c
    3  * \brief: implementation of the Vertices class, derived from DataSet class
     2 * \file Vertices.cpp
     3 * \brief: Implementation of Vertices class, derived from DataSet class.
    44 */
    55

  • issm/trunk-jpl/src/c/Container/Vertices.h

    r14100 r14476  
    1 /*!\file: Vertices.h
    2  * \brief prototypes for Vertices.h
    3  */
    4 
    51#ifndef _CONTAINER_VERTICES_H_
    62#define  _CONTAINER_VERTICES_H_
    … …  
    1511class Inputs;
    1612
     13/*!\brief Declaration of Vertices class.
     14 *
     15 * Declaration of Vertices class.  Vertices are vector lists (Containers) of Vertex objects.
     16 * A vertex is a set of (x,y,z) coordinates defining the location of points in the mesh (not
     17 * to be confused with a node, which is a degree of freedom (DOF) for a particular analysis).
     18 */
    1719class Vertices: public DataSet{
    1820
Note: See TracChangeset for help on using the changeset viewer.