Changeset 7297 for code/branches/doc/src/libraries/network/ClientInformation.cc

Timestamp:

Aug 31, 2010, 8:37:29 PM (14 years ago)

Author:

landauf

Message:

fixed lots of Doxygen warnings

Note: Doxygen prints a warning if only a part of the parameters of a function are documented.

Added documentation for missing parameters (as good as I could), removed documentation of obsolete parameters and fixed names of renamed parameters.
Some parameters are tagged with "FIXME", please replace this with an appropriate documentation if you know what it does.

File:

• code/branches/doc/src/libraries/network/ClientInformation.cc (modified) (2 diffs)

code/branches/doc/src/libraries/network/ClientInformation.cc

@@ -230 +230 @@
   * This function should only be applied to the head of the list
   * @param clientID id to look for
+  * @param look_backwards FIXME - add doc? parameter unused?
   * @return pointer to the last element in the list or 0 if the search was unsuccessfull
   */
@@ -244 +245 @@
   * This function goes forward through the list and looks for an element with clientID
   * This function should only be applied to the head of the list
-  * @param peer peer to look for
+  * @param address peer to look for
+  * @param look_backwards FIXME - add doc? parameter unused?
   * @return pointer to the element in the list
   */