diff options
| author |  David Aspinall <da@inf.ed.ac.uk> | 2002-07-18 12:02:42 +0000 |
|---|---|---|
| committer | David Aspinall <da@inf.ed.ac.uk> | 2002-07-18 12:02:42 +0000 |
| commit | e14e4ca31658ee6369c68601c9c7ad7114e1f7ae (patch) | |
| tree | ea7e10733fbbb232a873f77a79b0f4997d6eac57 /html | |
| parent | 4d6f948b58053bcbcbfa8c2a17ded070fb5cadda (diff) | |
Add links for TeXinfo and docstrings
Diffstat (limited to 'html')
| -rw-r--r-- | html/components.html | 35 |
1 files changed, 17 insertions, 18 deletions
diff --git a/html/components.html b/html/components.html index b41bb59b..83767632 100644 --- a/html/components.html +++ b/html/components.html @@ -43,24 +43,23 @@ for more details. <h2>Docstring magic: Elisp documentation to TeXinfo extraction</h2> <p> -This package generates Texinfo source fragments from Emacs -docstrings. This avoids documenting functions and variables -in more than one place, and automatically adds Texinfo markup -to docstrings. It's a bit like <tt>javadoc</tt> for -Emacs Lisp, except that you must write a skeleton <tt>texi</tt> -file which contains magic comments mentioning the function or -variable names you want documented. -</p> -<p> -The package consists of one file: -<ul> -<li><a href="ProofGeneral-latest/generic/texi-docstring-magic.el">texi-docstring-magic.el</a></li> -</ul> -which contains documentation and usage hints. -For an extensive example of it's use, see -the <a href="ProofGeneral-latest/doc/PG-adapting.texi">source</a> -for the <a href="adapting">PG adapting manual</a>. -</p> +This package generates <a +href="http://www.gnu.org/directory/texinfo.html">Texinfo</a> source +fragments from Emacs +<!-- WARNING: next URL subject to change with elisp ref man changes!! --> +<a href="http://www.gnu.org/manual/elisp/html_node/elisp_374.html#SEC374">documentation strings</a> which are embedded in Emacs lisp source and the +running interpreter. This avoids documenting functions +and variables in more than one place, and automatically adds Texinfo +markup to docstrings. It's a bit like <tt>javadoc</tt> for Emacs +Lisp, except that you must write a skeleton <tt>texi</tt> file which +contains magic comments mentioning the function or variable names you +want documented. </p> <p> The package consists of one file: <ul> +<li><a +href="ProofGeneral-latest/generic/texi-docstring-magic.el">texi-docstring-magic.el</a></li> +</ul> which contains documentation and usage hints. For an extensive +example of it's use, see the <a +href="ProofGeneral-latest/doc/PG-adapting.texi">source</a> for the <a +href="adapting">PG adapting manual</a>. </p> <hr> |