Hans-Peter Diettrich <[email protected]> hat am 12. Februar 2012 um 12:31 geschrieben:
> Mattias Gaertner schrieb:
>
> > Documentation rework, removes aprox. 600 occurences of [?] and other
> > non-sense from the documentation
> >
> > Thanks. It seems the pattern is [...?].
> >
> > Dodi, is this the only pattern?
>
> See StyleGuide.txt:
>
> Everybody can add revision marks.
> I use brackets for now, to indicate passages with questionable content:
> [?] unclear wording, possibly wrong. Long: [what's this?]
> [???] unreadable or definitely wrong description.
> [~] somebody else should make this proper and nice English.
> [!] Incompatible or wrong implementation, e.g. [Delphi incompatible!]
Sometimes some text is inserted. For example [what's this?]. Is this text always inserted right after the edged bracket open and in front of the question mark?
>
> When such notes shall no more be added, please update this file accordingly.
>
>
> One last note:
> When it is unwanted or impossible to add notes to the documents in e.g.
> FPDoc Editor, what's the preferred procedure then? Are bug reports
> required, or what's the suggested way to ask for clarification or
> correction of incomplete or wrong documentation?
> When such notes shall no more be added, please update this file accordingly.
>
>
> One last note:
> When it is unwanted or impossible to add notes to the documents in e.g.
> FPDoc Editor, what's the preferred procedure then? Are bug reports
> required, or what's the suggested way to ask for clarification or
> correction of incomplete or wrong documentation?
As I wrote: IMO in most cases mantis bug reports would create too much overhead. The fpdoc notes are better.
I converted the notes for elements and topics to fpdoc notes.
ToDo: extend fpdoc editor to edit fpdoc notes and a function to list them and/or jump to next/prev note.
Mattias
-- _______________________________________________ Lazarus mailing list [email protected] http://lists.lazarus.freepascal.org/mailman/listinfo/lazarus
