<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type"/>
</head>
<body>
<p id="mceDummy" style="margin: 0pt;"> </p>
<p style="margin: 0px;" class="mceNewlinePreserve"> </p>
<div id="mcePresetContent" style="margin: 5px 0px;" class="mceHTML">
<br/>
Hans-Peter Diettrich <DrDiettrich1@aol.com> hat am 12. Februar 2012 um 12:31 geschrieben:
<br/>
<br/>
> Mattias Gaertner schrieb:
<br/>
>
<br/>
> > Documentation rework, removes aprox. 600 occurences of [?] and other
<br/>
> > non-sense from the documentation
<br/>
> >
<br/>
> > Thanks. It seems the pattern is [...?].
<br/>
> >
<br/>
> > Dodi, is this the only pattern?
<br/>
>
<br/>
> See StyleGuide.txt:
<br/>
>
<br/>
> Everybody can add revision marks.
<br/>
> I use brackets for now, to indicate passages with questionable content:
<br/>
> [?] unclear wording, possibly wrong. Long: [what's this?]
<br/>
> [???] unreadable or definitely wrong description.
<br/>
> [~] somebody else should make this proper and nice English.
<br/>
> [!] Incompatible or wrong implementation, e.g. [Delphi incompatible!]
</div>
<p style="margin: 0px;"> </p>
<p>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?</p>
<p> </p>
<p style="margin: 0px;"> </p>
<div id="mcePresetContent" style="margin: 5px 0px;" class="mceHTML">
>
<br/>
> When such notes shall no more be added, please update this file accordingly.
<br/>
>
<br/>
>
<br/>
> One last note:
<br/>
> When it is unwanted or impossible to add notes to the documents in e.g.
<br/>
> FPDoc Editor, what's the preferred procedure then? Are bug reports
<br/>
> required, or what's the suggested way to ask for clarification or
<br/>
> correction of incomplete or wrong documentation?
</div>
<div> </div>
<div>As I wrote: IMO in most cases mantis bug reports would create too much overhead. The fpdoc notes are better.</div>
<div> </div>
<div>I converted the notes for elements and topics to fpdoc notes.</div>
<div> </div>
<div>ToDo: extend fpdoc editor to edit fpdoc notes and a function to list them and/or jump to next/prev note.</div>
<div> </div>
<div>Mattias</div>
<div> </div>
<p id="mceDummyTail" style="margin: 0px;"> </p>
</body>
</html>