Changeset 7291 for code/branches/doc/src/libraries/util/SubString.h

Timestamp:

Aug 31, 2010, 5:19:36 PM (14 years ago)

Author:

landauf

Message:

the @example tag shouldn't be used in a documentation unless the whole file is an example implementation

File:

• code/branches/doc/src/libraries/util/SubString.h (modified) (1 diff)

code/branches/doc/src/libraries/util/SubString.h

@@ -47 +47 @@
  * but also removing leading and trailing spaces around the comma.
  *
- * @example
+ * Example:
  * Split the String std::string st = "1345, The new empire   , is , orxonox"
  * is splitted with:
- * SubString(st, ',', " \n\t")
+ * @code SubString(st, ',', " \n\t") @endcode
  * into
  * "1345", "The new empire", "is", "orxonox"