[Lazarus] A report on documentation editors

Alexander Klenin klenin at gmail.com
Fri Oct 9 11:11:51 CEST 2009


On Fri, Oct 9, 2009 at 18:55, Michael Van Canneyt
<michael at freepascal.org> wrote:
> On Fri, 9 Oct 2009, Alexander Klenin wrote:
>
>> 4) Help files generated by FPDoc utility miss description of
>> enumeration constants.
>
> No they don't ?
>
> See e.g. http://www.freepascal.org/docs-html/rtl/classes/tfilerflag.html
>
> If you mean the full <descr> tag, then: yes, it is unused.

Yes, this is what I meant.

> But this is 'by design'. The idea is that you describe the various
> enumerated values in depth in the description of the enumerated type itself.

If so, then there are two bugs here:
1) FPDoc should issue an error upon encountering <descr> field for
enumeration constant.
2) FPDoc editor should not allow entering it.

-- 
Alexander S. Klenin




More information about the Lazarus mailing list