Recent

Author Topic: fpDoc, XML documentation comments  (Read 534 times)

vejrous

  • New Member
  • *
  • Posts: 17
fpDoc, XML documentation comments
« on: June 01, 2022, 11:21:40 pm »
Hello,
are there any plans for fpDoc to include support for in code xml documentation comments?

I know there is a way to have comments in a separate file.

Example:
https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/
or
https://docwiki.embarcadero.com/RADStudio/Sydney/en/XML_Documentation_Comments




PascalDragon

  • Hero Member
  • *****
  • Posts: 4549
  • Compiler Developer
Re: fpDoc, XML documentation comments
« Reply #1 on: June 02, 2022, 08:52:50 am »
are there any plans for fpDoc to include support for in code xml documentation comments?

No, there is not. If you want in-code documentation, use PasDoc.

vejrous

  • New Member
  • *
  • Posts: 17
Re: fpDoc, XML documentation comments
« Reply #2 on: June 10, 2022, 09:56:00 pm »
Ok, I downloaded fpDoc source including makeskel utility.
My idea was to modify makeskel so it creates skeleton with included (and transformed) xml comments and than run fpDoc.

Problem is that makeskel does not compile even from source (wrong array size, object missing,..).
Is it current master broken or am I missing something?

Thank You for answer.

wp

  • Hero Member
  • *****
  • Posts: 10045
Re: fpDoc, XML documentation comments
« Reply #3 on: June 10, 2022, 11:00:29 pm »
Compilation of fpdoc and makeskel works for me (based on the code of FPC-main; just had to remove the paths specified in "working directory" of the "Run parameters").

 

TinyPortal © 2005-2018