1 files changed, 16 insertions, 2 deletions
diff --git a/src/commentcnv.h b/src/commentcnv.h
index 0ab6d9c..500b10c 100644
--- a/src/commentcnv.h
+++ b/src/commentcnv.h
@@ -18,11 +18,25 @@
 #ifndef COMMENTCNV_H
 #define COMMENTCNV_H
 
+/** @file
+ *  @brief First pass comment processing.
+ */
+
 class BufStr;
 class QCString;
 
-extern void convertCppComments(BufStr *inBuf,BufStr *outBuf,
-                               const QCString &fileName);
+/** Converts the comments in a file.
+ *  @param inBuf    input buffer holding the file content.
+ *  @param outBuf   output buffer to which the results after conversion are written to.
+ *  @param fileName the name of the file from which the comments originate.
+ *
+ *  The following is converted:
+ *  - C++ style multiline doxygen comments are converted to C style doxygen comments.
+ *  - conditional sections are processed.
+ *  - aliases are expanded.
+ */
+void convertCppComments(const BufStr &inBuf,BufStr &outBuf,
+                        const QCString &fileName);
 
 #endif