diff --git a/Doc/Manual/Contents.html b/Doc/Manual/Contents.html index 22f6126de..06dd91ae6 100644 --- a/Doc/Manual/Contents.html +++ b/Doc/Manual/Contents.html @@ -1397,6 +1397,10 @@
+The features described in this section can be used to generate documentation +comments (colloquially referred to as "docstrings") that can be read by +OCamldoc. +
+ ++The first documentation comment of an mli file is the comment +associated with the entire module. SWIG supports this by setting an +option of the %module directive. For example: +
+ ++%module(docstring="This is the example module's docstring") example ++
+When you have more than just a line or so, you can retain the +readability of the %module directive by using a macro. For +example: +
+ ++%define DOCSTRING +"The `XmlResource` class allows program resources defining menus, +controls on a panel, etc. to be loaded from an XML file." +%enddef + +%module(docstring=DOCSTRING) xrc ++