ucw. docs: document single-line doc. comments

[libucw.git] / ucw / doc / docsys.txt

diff --git a/ucw/doc/docsys.txt b/ucw/doc/docsys.txt
index 3bb1703fc1d30fe6c201db38b0837f1e292db2e7..b855749acea7e02c158d1cf108724bcbb41e7089 100644 (file)
--- a/ucw/doc/docsys.txt
+++ b/ucw/doc/docsys.txt
@@ -91,10 +91,15 @@ Definition comments
 You can write comments documenting specific definition. Definition
 comment has the asterisks doubled. The multi-line version must be
 directly above the definition, the single-line on the same line right
 You can write comments documenting specific definition. Definition
 comment has the asterisks doubled. The multi-line version must be
 directly above the definition, the single-line on the same line right

-of the definition.
+of the definition or on a line before.

 
  void function(int parameter);  /** This is a function. **/
 
 
  void function(int parameter);  /** This is a function. **/
 

+or
+
+ /** This is a function. **/
+ void function(int parameter);
+

 or
 
  /**
 or
 
  /**