[Lazarus] FPDoc Editor vs Lazarus Documentation Tool

[silvioprog]

On Sat, Dec 20, 2014 at 9:18 AM, Graeme Geldenhuys <
mailinglists at geldenhuys.co.uk> wrote:

> On 2014-12-20 11:29, Mattias Gaertner wrote:
> > What does it not allow exactly?
>
> The built-in editor does very weird indentation, and there is no option
> to switch indentation off completely. Here is a quick example I just
> created with the built-in editor. Also note that the built-in editor
> simply appends to the end of the file. So the <module> description is
> somewhere in the middle of the file because I didn't write it first (I
> know it doesn't matter to fpdoc, but it does to me).
>
> ================================
> <?xml version="1.0" encoding="UTF-8"?>
> <fpdoc-descriptions>
>   <package name="project1">
>     <module name="mycomponent">
>       <element name="TMyComponent">
>         <short>My short description</short>
>         <descr><printshort id="TMyComponent"/>. My long description goes
> here.</descr>
>         <seealso>TObject</seealso>
>       </element>
>     <descr><p>This unit contains my cool component.</p><p>It is just
> what I wanted.</p>
>       </descr><element name="TMyComponent.Name"><short>Describes the
> name of the object</short>
>       </element>
>     </module>
>   </package>
> </fpdoc-descriptions>
> =================================
>
> I would have written it manually as follows to make sure fpdoc doesn't
> get whitespace errors, plus I have more control over ordering the
> documentation (not that it really makes a difference to fpdoc).
>
> ==================================
> <?xml version="1.0" encoding="UTF-8"?>
> <fpdoc-descriptions>
> <package name="project1">
>
> <module name="mycomponent">
> <descr><p>This unit contains my cool component.</p><p>It is just what I
> wanted.</p></descr>
>
> <element name="TMyComponent">
> <short>My short description</short>
> <descr><printshort id="TMyComponent"/>. My long description goes
> here.</descr>
> <seealso>TObject</seealso>
> </element>
>
> <element name="TMyComponent.Name">
> <short>Describes the name of the object</short>
> </element>
> </module>
>
> </package>
> </fpdoc-descriptions>
> ==================================
>
>
> Doing it manually with code templates, I'm just as fast as the built-in
> editor, so it's note a speed thing. ;-)


So why not add this option in the built-in editor? It seems a nice
alternative to who want work using only Lazarus IDE. =)

--
Silvio Clécio
My public projects - github.com/silvioprog
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.lazarus-ide.org/pipermail/lazarus/attachments/20141220/6883532b/attachment-0003.html>