From: Michal Vaner <vorner@ucw.cz>
Date: Sun, 15 Feb 2009 12:13:54 +0000 (+0100)
Subject: ucw. docs: document single-line doc. comments
X-Git-Tag: holmes-import~75
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=dbe3b315edac25079fcbfe4df20e80b534f2a7a1;p=libucw.git

ucw. docs: document single-line doc. comments
---

diff --git a/ucw/doc/docsys.txt b/ucw/doc/docsys.txt
index 3bb1703f..b855749a 100644
--- 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
-of the definition.
+of the definition or on a line before.
 
  void function(int parameter);  /** This is a function. **/
 
+or
+
+ /** This is a function. **/
+ void function(int parameter);
+
 or
 
  /**