mORMot Open Source

gaddlord

Member

Registered: 2012-01-02

Posts: 8

Website

Fix the comments to be in DocType format with /// prefix

All existing comments are in

{{ ... }} form where they should be in

/// ...
/// ...

form.

Please fix those in order to have nice integrated help suggestions when using latest versions of Delphi.

for example this

{{ Prepare a UTF-8 encoded SQL statement
   - compile the SQL into byte-code
   - parameters ? ?NNN :VV @VV $VV can be bound with Bind*() functions below
   - raise an ESQLException on any error }
function Prepare(DB: TSQLite3DB; const SQL: RawUTF8): integer;

should become

/// <summary>
/// Prepare a UTF-8 encoded SQL statement
/// compile the SQL into byte-code
/// parameters ? ?NNN :VV @VV $VV can be bound with Bind*() functions below
/// </summary>
/// <param name="DB"></param>
/// <param name="SQL"></param>
/// <returns></returns>
/// <exception cref="ESQLException">raise an ESQLException on any error</exception>
function Prepare(DB: TSQLite3DB; const SQL: RawUTF8): integer;

Leander007

Member

From: Slovenia

Registered: 2011-04-29

Posts: 113

Re: Fix the comments to be in DocType format with /// prefix

You can see, that this was discussed already too .
Regarding xmldoc starts from here.

---

"Uncertainty in science: There no doubt exist natural laws, but once this fine reason of ours was corrupted, it corrupted everything.", Blaise Pascal

ab

Administrator

From: France

Registered: 2010-06-21

Posts: 14,660

Website

Re: Fix the comments to be in DocType format with /// prefix

We do not use XMLDoc to generate the documentation, but the PasDoc format.

And our SynProject tool which is much more powerful than any other tool I know about to write the documentation.

XMLDoc format may be added as an alternate.

Thanks Leander007 for the link.
GadLord, please first check in the forum is there is not such a post already in there - as stated by the forum rules - http://synopse.info/forum/misc.php?action=rules