Changeset d236a6 in git for templates

Timestamp:

May 19, 2010, 9:48:29 PM (13 years ago)

Author:

Oleksandr Motsak <motsak@…>

Branches:

(u'jengelh-datetime', 'ceac47cbc86fe4a15902392bdbb9bd2ae0ea02c6')(u'spielwiese', '0604212ebb110535022efecad887940825b97c3f')

Children:

51d8358d00637f692154a3219232867ffa3890a0

Parents:

bcfa2000ff3ca226cf5d9db48e56d15b0857ffa3

git-author:

Oleksandr Motsak <motsak@mathematik.uni-kl.de>2010-05-19 21:48:29+02:00

git-committer:

Mohamed Barakat <mohamed.barakat@rwth-aachen.de>2011-11-09 11:52:58+01:00

Message:

Experiments with in-line descriptions for params :(

Location:

templates

Files:

• template.h (modified) (3 diffs)
• test.h (added)

templates/template.h

@@ -67 +67 @@
    * Long: [detailed method description]
    *
-   * @param
+   * @param [in] a some int
+   * @param [in] b another int
+   * @param [out] result integer result
+   *
    * @return [information about return value]
    * @sa [see also section]
@@ -74 +77 @@
    * @exception std::exception Some explanation of what causes this exception.
    */
-  void MethodTemplate(
-         const int a, ///< [in] some int
-         const int b, ///< [in] another int
-         int & result ///< [out] integer result
-                     );
+  void MethodTemplate( const int a, const int b, int & result );
 
   ///
@@ -90 +89 @@
   /// and destination strings overlap.
   ///
-  /// @param
   /// @return @a strcpy returns the destination string.
   /// No return value is reserved to indicate an error.