[Lazarus] Lazarus has unique font sizes

[Graeme Geldenhuys]

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. The tiTokenLibrary.pas unit documentation. You 
cannot edit this with lazde or the internal fpdoc editor. I have to 
manually edit this is the xml file.

http://opensoft.homeip.net/tiopf/core/titokenlibrary/index.html

and here is the actual documentation for that unit (overview).

======================
     <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.



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

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

and the actual xml doc file. As you can see I use the "printshort" tag, 
so the short description is duplicated in the long description. So if I 
update the short description, the long description (first sentence) is 
automatically updated. No manual text duplication.

===========================
       <element name="TTokens">
         <short>This is the string tokenizer</short>
         <descr>
           <p>
             <printshort id="TTokens"/>. It is based on a Finite State 
Machine design pattern.  The following image shows how the State Machine 
works.</p>
           <img file="../../images/tiTokenLibrary_Diagram.png" 
name="tokenlibrary_overview" alt="tiTokenLibrary overview"/>
         </descr>
===========================


> On the short description page there is room for an extra button.
> On the long description page there is no room. Maybe it could be added  
> to the popup menu.
> Make a proposal.

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".



Regards,
   - Graeme -

-- 
fpGUI Toolkit - a cross-platform GUI toolkit using Free Pascal
http://opensoft.homeip.net/fpgui/

-------------- next part --------------
A non-text attachment was scrubbed...
Name: fpdoc_editor.png
Type: image/png
Size: 6990 bytes
Desc: not available
URL: <http://lists.lazarus-ide.org/pipermail/lazarus/attachments/20090817/ade90813/attachment-0004.png>