diff --git a/README.md b/README.md index bd13b16..9038c64 100644 --- a/README.md +++ b/README.md @@ -97,12 +97,32 @@ DEFUN_DLD (libsvmread, args, nargout, This function ... ```` +* Small docstrings containing a single line of help text after the `@deftypefn` tag must have an additional empty line before `@end deftypefn` in order to be parsed correclty. For example, the following docstring +```` +## -*- texinfo -*- +## @deftypefn {RTree} {@var{n} =} rect_size () +## +## The size @var{n} in bytes of a rectangle. +## @end deftypefn +```` +must be +```` +## -*- texinfo -*- +## @deftypefn {RTree} {@var{n} =} rect_size () +## +## The size @var{n} in bytes of a rectangle. +## +## @end deftypefn +```` +in order to be properly formatted in final HTML code. + * `@math{}` texi tags are converted to `` tags in HTML and their contents are scanned for `x` and `*` characters, which are replaced by `×` in order to properly display the multiplication symbol. Make sure that lower case `x` within the `@math{}` tags is explicitly used for denoting multiplication and it is not used for anything else (e.g. variable name). This feature, introduced in release 0.4.7, only affects the contents of `@math{}` texi tags. * At the moment, `function_texi2html` can handle a signle `@seealso{}` tag. Make sure that there is only one `@seealso{}` tag inside each function's docstring located at the very end just before the `@end deftypefn` texinfo closing statement. Functions listed therein that belong to the same package are also linked to their individual function pages. * `@tex` tags must only contain latex mathematical expressions enclosed with `$$` identifiers, such as in `$$ ... $$`. Math delimiters `\(...\)` are also processed in `@tex` blocks. + ## TODO 1. Implement functionality for listing alphabetically all functions available