
<html>

  <head>


    <meta http-equiv="content-type" content="text/html; charset=UTF-8">

  </head>

  <body text="#000000" bgcolor="#FFFFFF">

    <p>Fixing a docs-related issue today

      (<a class="moz-txt-link-freetext" href="https://bugs.freepascal.org/view.php?id=36452">https://bugs.freepascal.org/view.php?id=36452</a>), I noticed that

      the entry for TCanvas.PolyBezier almost does not have any elements

      when the item is displayed in the <b>FPDoc editor</b> of Lazarus,

      i.e. I do "View" > "FPDoc Editor" and place the cursor in the

      normal source code window on the PolyBezier identifier - then the

      FPDoc editor displays only the "short" text, all other tabs are

      empty. On the other hand, the full chm file contains a lot more

      information

(<a class="moz-txt-link-freetext" href="https://lazarus-ccr.sourceforge.io/docs/lcl/graphics/tcanvas.polybezier.html">https://lazarus-ccr.sourceforge.io/docs/lcl/graphics/tcanvas.polybezier.html</a>),

      among it the description node which is the topic of that bug

      report.</p>

    <p>How is this possible?<br>

    </p>

    <p>On the other hand, opening the file graphics.xml in the <b>LazDocEditor

      </b>and finding the TCanvas node shows two PolyBezier nodes. The

      first one contains the text from the chm file, the second one has

      subnodes for the parameters of the function - there is no text

      assigned to them, but some of them are listed twice.</p>

    <p>There are other help items which show the same phenomenon: Chord,

      Polygon, PolyLine, RadialPie, where Polygon even has three

      entries!</p>

    <p>Is this correct? If yes it is at least very confusing and makes

      the LazDocEditor possibly a dangerous tool because the xml file

      might be damaged when text is added to the wrong node.<br>

    </p>

    <p>Can both tools, FPDoc Editor and LazDocEditor, be used to edit

      help information? Or is it recommended to do this manually (which

      is extremely error-prone)?</p>

    <p>And why are there so many empty lines? If they were added by

      either FPDocEditor or LazDocEditor (and not by the author

      manually) then these tools do not look very mature.</p>

    <p>Probably related: the source code mouse-over hint of PolyBezier

      shows only the "short" text, not the full "description".<br>

    </p>

    <p>Werner<br>

    </p>

  </body>

</html>