[Lazarus] Adding Notes in FPDoc

waldo kitty wkitty42 at windstream.net
Tue Feb 14 03:54:42 CET 2012


On 2/13/2012 19:24, Hans-Peter Diettrich wrote:
> Michael Van Canneyt schrieb:
>
>> Now the lazarus team needs to decide how it intends to use the new feature.
>> When a decision has been reached, I'll see how I can help (if any help is
>> still needed).
>
> This reminds me on: Here's the solution, where's the problem?

i wanted to also add to this that, as i mentioned to another participant in this 
discussion, the original notes were (apparently?) a problem for one developer, 
and the notes were (apparently?) intended to lead others to update, correct, or 
add to the documentation but (and here's my question) what about the possibility 
of "local" notes... notes that are only stored on the local machine?

in other words, there are notes, like the "[?]" and "[what?]" ones that were 
removed, which appear to have been done for publishing to all so that the docs 
could be fixed up... so, i was also thinking that those notes might have been 
for "local" purposes so that the one who created them would have something as a 
reminder to go back to for the completion...

so, basically, i'm working on the documentation and write a "local" note that 
only belongs on my machine so that it doesn't "pollute" the documentation... 
then i would find the answer and complete the documentation or alter the note so 
that it is no longer limited to my local machine and thus would bring the 
situation to others' attention...

is this something that would be beneficial or no? i can see where the notes 
would be stored in possibly additional files that either traveled with the 
documentation files or were included in those files for all to see (if 
configured for such)... i really likes graeme's description of how he uses 
annotations and the like but i have not yet gotten to the point where i can see 
or use his method(s) but the question still came to my mind about local-only 
annotations, notes, updates, etc... and how they might be handled or if this 
possibility was even considered...




More information about the Lazarus mailing list