mORMot Open Source

EMartin

Member

From: Buenos Aires - Argentina

Registered: 2013-01-09

Posts: 337

Classes and methods documentation not generated

Hi @ab, I have units with documentation on classes and methods but SynProject not generated that detailed info, only the unit description, the class description, the units used and the class hierarchy.

What am I doing wrong ?

Thanks in advance.

---

Esteban

ab

Administrator

From: France

Registered: 2010-06-21

Posts: 14,661

Website

Re: Classes and methods documentation not generated

What does the log parsing say?
(there is a SAD.log file in the output folder)

The parser only handle Delphi 7 syntax: if you use generics, it may fail.
I would need to update the integrated parser.

Also ensure that the comments start with three slashes /// not two //.

EMartin

Member

From: Buenos Aires - Argentina

Registered: 2013-01-09

Posts: 337

Re: Classes and methods documentation not generated

SAD.log:

9/14/2015 6:59:56 PM
Info[0]:    Cache file = D:\DevVM\D7\Projects\ARIS\Docs\ARIS\Approach RIS\Approach RIS.sad
Info[0]:    [SAD].Source = Main

FillUnits(SAD-Main) -> ARIS_Svc.dpr;ARIS_Intf.pas;ARIS_Server.pas;ARIS_Server_Config.pas;ARIS_Utils.pas;ARISCallbacks_Intf.pas;ARISCallbacks_Impl.pas;DBService_Intf.pas;DBService_Impl.pas;MiscService_Intf.pas;MiscService_Impl.pas;MySynDB.pas
Info[0]:    DefaultPath = D:\DEVVM\D7\PROJECTS\ARIS\
Info[0]:    IncludePath = D:\DevVM\D7\Projects\ARIS
Info[0]:    Directives =
Info[2]:    ARIS_Svc.dpr from cache
Info[2]:    ARIS_Intf.pas from cache
Info[2]:    ARIS_Server.pas from cache
Info[2]:    ARIS_Server_Config.pas from cache
Info[2]:    ARIS_Utils.pas from cache
Info[2]:    ARISCallbacks_Intf.pas from cache
Info[2]:    ARISCallbacks_Impl.pas from cache
Info[2]:    DBService_Intf.pas from cache
Info[2]:    DBService_Impl.pas from cache
Info[2]:    MiscService_Intf.pas from cache
Info[2]:    MiscService_Impl.pas from cache
Info[2]:    MySynDB.pas from cache
Info[2]:    CP_Impl.pas from cache
Info[2]:    SMA_Impl.pas from cache

Info[2]:    Files not found during process:
ADODB.pas,Classes.pas,DB.pas,DBClient.pas,FastMM4.pas,IdAttachmentFile.pas,IdExplicitTLSClientServerBase.pas,IdIOHandler.pas,IdMessage.pas,IdSASL_NTLM.pas,IdSASLLogin.pas,IdSMTP.pas,IdSSLOpenSSL.pas,IdSSLOpenSSLHeaders.pas,IdUserPassProvider.pas,JCLSecurity.pas,JCLStrings.pas,JvCipher.pas,MidasSpeedFix.pas,mORMot.pas,mORMotDB.pas,mORMotHttpClient.pas,mORMotHttpServer.pas,mORMotMidasVCL.pas,mORMotService.pas,mORMotSQLite3.pas,StrUtils.pas,SuperObject.pas,SuperXMLParser.pas,SyncObjs.pas,SynCommons.pas,SynCrtSock.pas,SynDB.pas,SynDBMidasVCL.pas,SynDBZeos.pas,SynLog.pas,SynSQLite3Static.pas,SynTests.pas,SynVirtualDataset.pas,SysUtils.pas,Types.pas,Variants.pas,Windows.pas,WinSvc.pas,ZAbstractRODataset.pas,ZConnection.pas,ZDataset.pas,ZDbcInterbase6Utils.pas,ZDbcIntfs.pas,ZStoredProcedure.pas,ZURL.pas

I use Delphi 7.

The first line of comments start with three slashes "///" and then "// -..." (without quotes) of the procedures and functions.

I use @!unit.pas@ when added the unique references to the units.

Thanks.

---

Esteban

ab

Administrator

From: France

Registered: 2010-06-21

Posts: 14,661

Website

Re: Classes and methods documentation not generated

Flush the cache and check immediately the .log by running "SAD / Parse all source code again" from the menu.

I guess you may find an error. Perhaps a missing conditional.

Also ensure you put the .pas files as reference in the SourceFile=... entry of the [SAD-*] entries marked as Source= in the [SAD] entry.

EMartin

Member

From: Buenos Aires - Argentina

Registered: 2013-01-09

Posts: 337

Re: Classes and methods documentation not generated

Solved, my SAD-Main section had not the input WithAllfields=Yes, why ? I don't know.

Thanks.

---

Esteban