On Sun, 13 Mar 2011, Mattias Gaertner wrote:
On Sun, 13 Mar 2011 08:59:34 +0100
Hans-Peter Diettrich <[email protected]> wrote:
Mattias Gaertner schrieb:
Problems arise with branches.
For example?
When I work in a local branch, and find something worth to document,
then this documentation is added to the branch and removed when
switching back to another branch.
Why not merge the change to the other branches?
[...]
In the second case a list of help directories is required, that can be
maintained by the user or package system. A single machine-specific xml
directory may be sufficient, with subdirectories for all packages, so
that no existing help file can be missed in the search. A concrete unit
owner is not required, the help directory name can be used for that
purpose. E.g. the complete LCL help can be created from
<helpdir/xml>/lcl/*.xml.
How can help files for lcl version 1.0 and lcl version 2.0 be
distinguished?
When this matters, the user can create separate doc folders.
How should that work with the above search pattern
<helpdir/xml>/lcl/*.xml.
?
[...]
Only the final documentation may have to know about versions, so that
the proper overviews can be created for the 1.0 and 2.0 version. IMO
such overviews *always* should be created from the source code of the
proper version (like makeskel does), not from manually maintained lists
in help or topic files. The related entries then can be collected from
the separate help files, where every item can be tagged with the version
that introduced (moved, renamed...) that source code item.
AFAIK fpdoc does not support such tagging.
It does. The <version> tag has the same format as the <descr> tag.
It is even documented :-)
Michael.
--
_______________________________________________
Lazarus mailing list
[email protected]
http://lists.lazarus.freepascal.org/mailman/listinfo/lazarus
