Changeset 4f6451 in git for templates/template.h


Ignore:
Timestamp:
May 26, 2010, 3:02:51 AM (14 years ago)
Author:
Oleksandr Motsak <motsak@…>
Branches:
(u'spielwiese', 'fe61d9c35bf7c61f2b6cbf1b56e25e2f08d536cc')
Children:
86af4354bff633abee51c0986c90e8869b2d30af
Parents:
7dc3e1ccdbb09e272b92ea5e626578cdfadb0864
git-author:
Oleksandr Motsak <motsak@mathematik.uni-kl.de>2010-05-26 03:02:51+02:00
git-committer:
Mohamed Barakat <mohamed.barakat@rwth-aachen.de>2011-11-09 11:54:57+01:00
Message:
More or less finished templates!
File:
1 edited

Legend:

Unmodified
Added
Removed

  • templates/template.h

    r7dc3e1c r4f6451  
    1 // -*- c++ -*-
    2 /***************************************************************************//**
    3  * @file template.h
     1//*****************************************************************************
     2// Computer Algebra System SINGULAR   
     3// Copyright: See COPYING file that comes with this distribution
     4//*****************************************************************************
     5/** @file template.h
    46 *
    5  * This file defines the class TEMPLATE. AAA. BBB.
    6  * CCC.
     7 * This file defines the class TEMPLATE.
    78 *
    8  * DDDD.
     9 * ABSTRACT: We need this for something...
    910 *
    1011 * @author Oleksandr Motsak
    1112 *
    12  * @par Copyright:
    13  *   (C) by The SINGULAR Team, see COPYING file
    14  * EEE.
     13 * @internal @version \$Id$
    1514 *
    16  * FFFFFFFF.
    17  *
    18  * FFFFFFFFFFFFFFFFFFFFFFFFF.
    19  * @internal
    20  * @version \$Id$
    21  *
    22  ******************************************************************************/
     15 **/
     16//*****************************************************************************
     17
     18#ifndef SINGULAR_TEMPLATE_CLASS_h_
     19#define SINGULAR_TEMPLATE_CLASS_h_
    2320
    2421// include basic definitions
    2522#include "singularxx_defs.h"
    2623
    27 #ifndef SINGULAR_TEMPLATE_CLASS_h_
    28 #define SINGULAR_TEMPLATE_CLASS_h_
    29 
    3024BEGIN_NAMESPACE_SINGULARXX
    3125
    32 /** @class TEMPLATE template.h somRootDirectory/template.h
     26/** @class TEMPLATE template.h "someRootDirectory/template.h"
    3327 *
    34  * [brief description of class TEMPLATE].
     28 * Brief description of class TEMPLATE.
    3529 *
    36  * [detailed description of class TEMPLATE].
    37  * AAAA.
    38  * @par blah, blah, ..., blah.
     30 * Detailed description of class TEMPLATE.
    3931 *
    40  * @sa see alsos
     32 * @sa some other classes
    4133 */
    42 class TEMPLATE: public TEMPLATE_BASE_CLASS  // doxygen will document the inheritance automatically
     34class TEMPLATE: public TEMPLATE_BASE_CLASS
    4335{
    44 
    4536public:
    46   /// Name type of *this.
     37  /// Name type of *this.  
    4738  typedef TEMPLATE self;
    4839
    49   /// My enum. Not yours!
     40  /// My enum. Or yours, if you want!
    5041  enum My
    5142  {
    … …  
    5445  };
    5546
    56   /// Default constructor. And now goes the detailed description....
    57   ///
     47  /// Default constructor.
     48  /// And now goes the detailed description....
    5849  TEMPLATE();
    5950
    … …  
    6354 
    6455
    65   /** Brief: [method description].
     56  /** Brief method description.
    6657   *
    67    * Long: [detailed method description]
     58   * Detailed method description.
    6859   *
    6960   * @param [in] a some int
    70    * @param [in] b another int
    71    * @param [out] result integer result
    72    *
    73    * @return [information about return value]
    74    * @sa [see also section]
    75    * @note This will be hilighted in the documentation as a special note.
    76    * @warning [any warning if necessary]
    77    * @exception std::exception Some explanation of what causes this exception.
     61   * @param [out] o integer result
     62   * @return information about return value
     63   * @sa strcpy2
    7864   */
    79   void MethodTemplate( const int a, const int b, int & result );
     65  int Method( int a, int &o );
    8066
     67  /// Example of Copy a string method.
    8168  ///
    82   /// Brief: Example of Copy a string method.
    83   ///
    84   /// Long: The strcpy function copies @a strSource, including
     69  /// The strcpy function copies @a strSource, including
    8570  /// the terminating null character, to the location
    8671  /// specified by @a strDestination. No overflow checking
    … …  
    9176  /// @return @a strcpy returns the destination string.
    9277  /// No return value is reserved to indicate an error.
    93   /// @sa wcscpy(), _mbscpy(), strncpy()
    94   ///
     78  /// @sa Method(), wcscpy(), _mbscpy(), strncpy()
    9579  char* strcpy2(
    9680            char* strDestination,  ///< [out] pointer to source null terminated
    9781                                   ///< string ...
    9882                                   ///< continue ...
    99             const char* strSource, ///< [in] pointer to destination memory ....
     83            const char* strSource  ///< [in] pointer to destination memory ....
    10084                                   ///< continue ...
    101             const int a            ///< [in] counter
    10285               );
    10386
    10487
    10588protected:
    106 
    107   /// Short description
    108   bool m_bAnotherFlag;
    109 
    11089  /// Short description of some flag. Long description: use this format to document a variable or
    11190  /// method
    11291  bool m_bSomeFlag;
    113 
    11492};
    11593
Note: See TracChangeset for help on using the changeset viewer.