Commit 37c13cde authored by Geoff Simmons's avatar Geoff Simmons

Write up the $Synopsis directive for vcc files in "Upgrading".

parent 41071281
......@@ -538,7 +538,17 @@ Other changes
* Changes for developers:
* XXX ...
* VMOD vcc sources may now include a directive ``$Synopsis`` whose
value may be ``auto`` or ``manual``, default ``auto``.
When ``$Synopsis`` is ``auto``, the vmodtool generates a more
comprehensive ``SYNOPSIS`` section in the documentation than in
previous versions -- an overview of the objects, methods and
functions in your VMOD, with their type signatures.
When ``$Synopsis`` is ``manual``, the ``SYNOPSIS`` is left out of
the generated docs altogether; so you can write the ``SYNOPSIS``
section yourself, if you prefer.
* XXX ...
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment