Zitat von Graeme Geldenhuys <[email protected]>:

Mattias Gärtner wrote:

One thing the internal fpdoc editor editor cannot do is document a unit description.

Make a proposal.

Here is an example.[...]
======================
    <module name="tiTokenLibrary">
      <short>String tokenizer library</short>
      <descr>
<p>The TToken tokenizer is extremely flexible, being able to tokenize quite
complex strings. See the unit tests for examples of these. It is also a lot
faster than the previous string tokenizer function in tiUtils.
</p>
======================


Possible way I thought of how the internal fpdoc editor could do this. When you put the cursor on the "unit tiTokenLibrary" line of the unit, then fpdoc editor should edit the module tag documentation.

I didn't know that the unit description tags use the same format as the elements.
Ok, now you can edit it in the fpdoc editor.


Normally the long description is shown just below the short description.

Generated documentation
  http://opensoft.homeip.net/tiopf/core/titokenlibrary/ttokens.html

:)


[...]
Maybe add a new button as indicated in the attached image. But I think an even better option will be a popup menu item when your right click over the long description memo - "Insert printshort tag".

I added the popup menu item.

Mattias


--
_______________________________________________
Lazarus mailing list
[email protected]
http://lists.lazarus.freepascal.org/mailman/listinfo/lazarus

Reply via email to