Changeset 86af43 in git for templates/template.h


Ignore:
Timestamp:
May 26, 2010, 1:22:17 PM (14 years ago)
Author:
Oleksandr Motsak <motsak@…>
Branches:
(u'spielwiese', 'ec94ef7a30b928574c0c3daf41f6804dff5f6b69')
Children:
34942f9467977bbb6b5facb760ff89744af44034
Parents:
4f64517ef8ac7bbb54e92e032085d944fa163120
git-author:
Oleksandr Motsak <motsak@mathematik.uni-kl.de>2010-05-26 13:22:17+02:00
git-committer:
Mohamed Barakat <mohamed.barakat@rwth-aachen.de>2011-11-09 11:54:58+01:00
Message:
Our Doxygen style
File:
1 edited

Legend:

Unmodified
Added
Removed

  • templates/template.h

    r4f6451 r86af43  
    1 //*****************************************************************************
    2 // Computer Algebra System SINGULAR   
    3 // Copyright: See COPYING file that comes with this distribution
    4 //*****************************************************************************
     1/*****************************************************************************\
     2 * Computer Algebra System SINGULAR   
     3\*****************************************************************************/
    54/** @file template.h
    65 *
    7  * This file defines the class TEMPLATE.
     6 * This file defines the class Template.
    87 *
    98 * ABSTRACT: We need this for something...
    … …  
    1413 *
    1514 **/
    16 //*****************************************************************************
     15/*****************************************************************************/
    1716
    18 #ifndef SINGULAR_TEMPLATE_CLASS_h_
    19 #define SINGULAR_TEMPLATE_CLASS_h_
     17#ifndef TEMPLATE_H
     18#define TEMPLATE_H
    2019
    2120// include basic definitions
    … …  
    2423BEGIN_NAMESPACE_SINGULARXX
    2524
    26 /** @class TEMPLATE template.h "someRootDirectory/template.h"
     25/** @class Template template.h "someRootDirectory/template.h"
    2726 *
    28  * Brief description of class TEMPLATE.
     27 * Brief description of class Template.
    2928 *
    30  * Detailed description of class TEMPLATE.
     29 * Detailed description of class Template.
    3130 *
    3231 * @sa some other classes
    3332 */
    34 class TEMPLATE: public TEMPLATE_BASE_CLASS
     33class Template: public TemplateBaseClass
    3534{
    3635public:
    3736  /// Name type of *this. 
    38   typedef TEMPLATE self;
     37  typedef Template Self;
    3938
    4039  /// My enum. Or yours, if you want!
    41   enum My
     40  enum MyEnum
    4241  {
    4342    int EVal1, ///< Enum value 1
    … …  
    4746  /// Default constructor.
    4847  /// And now goes the detailed description....
    49   TEMPLATE();
     48  Template();
    5049
    5150  /// Default destructor.
    52   /// And now goes its detailed description....
    53   ~TEMPLATE();
     51  ~Template();
    5452 
    5553
    56   /** Brief method description.
    57    *
    58    * Detailed method description.
    59    *
    60    * @param [in] a some int
    61    * @param [out] o integer result
    62    * @return information about return value
    63    * @sa strcpy2
    64    */
    65   int Method( int a, int &o );
     54  /// Brief method description.
     55  ///
     56  /// Detailed method description.
     57  ///
     58  /// @return information about return value
     59  /// @sa strcpy2
     60  ///
     61  int someMethod(
     62             int a, ///< [in] some int
     63             int &o ///< [out] integer result
     64            );
    6665
    6766  /// Example of Copy a string method.
    6867  ///
    69   /// The strcpy function copies @a strSource, including
     68  /// The strcpy2 function copies @a strSource, including
    7069  /// the terminating null character, to the location
    7170  /// specified by @a strDestination. No overflow checking
    7271  /// is performed when strings are copied or appended.
    73   /// The behavior of @a strcpy is undefined if the source
     72  /// The behavior of @a strcpy2 is undefined if the source
    7473  /// and destination strings overlap.
    7574  ///
    76   /// @return @a strcpy returns the destination string.
     75  /// @return @a strcpy2 returns the destination string.
    7776  /// No return value is reserved to indicate an error.
    78   /// @sa Method(), wcscpy(), _mbscpy(), strncpy()
     77  /// @sa someMethod(), wcscpy(), _mbscpy(), strncpy()
    7978  char* strcpy2(
    80             char* strDestination,  ///< [out] pointer to source null terminated
    81                                    ///< string ...
     79            char* strDestination,  ///< [out] pointer to source null terminated.
    8280                                   ///< continue ...
    83             const char* strSource  ///< [in] pointer to destination memory ....
    84                                    ///< continue ...
     81            const char* strSource  ///< [in] pointer to destination memory.
    8582               );
    8683
    87 
    8884protected:
    89   /// Short description of some flag. Long description: use this format to document a variable or
    90   /// method
     85  /// Short description of some flag till first dot. Everything after that will
     86  /// be considered as a detaiiled description.
    9187  bool m_bSomeFlag;
    9288};
    … …  
    9591
    9692#endif
    97 /* #ifndef SINGULAR_TEMPLATE_CLASS_h_ */
     93/* #ifndef TEMPLATE_H */
Note: See TracChangeset for help on using the changeset viewer.