fpdoc extension: embed topic [Re: [fpc-devel] FPDoc sources]

Hans-Peter Diettrich DrDiettrich1 at aol.com
Wed Aug 31 15:55:14 CEST 2011


Martin schrieb:

>> Now we have 7 identifiers, all refering to the essentially same data 
>> type. IMO it's only excess work, to document all these elements by 
>> themselves, when finally only the property is of interest. Instead I'd 
>> prefer a single doc entry, for the property, that also describes the 
>> enum elements. All related elements then can be linked to that unique 
>> description.
> 
> IMHO the location of where the enum is located is not relevant to the 
> requirement of (or ability to the do without) scanning the source.

You got it :-)

> Never the less, this could be an interesting feature. If fpdoc could be 
> told (as part of the xml) that the documentation of an element should be 
> embgedded in the parent (enum element, in enum type), or even embedded 
> in a specific other node (a property specified by name, that uses the 
> enum).

I assume that this is already implemented.

DoDi




More information about the fpc-devel mailing list