EPESI base documentation available

cezar

Hello,

I've published DOXYGEN's documentation od EPESI (ver. 1.5.4 rev. 11060) modules/BASE, look here: http://cichocki.com.pl/epesi/ There is no additional comments added to the code, however in most of the cases names of the methods in classes are self explanatory.

Hope this will help 🙂

Cezar

p.s. Thank you for EPESI!

ajb

Ave Cezar 🙂

Some time ago I was trying to generate documentation for the whole of the project but it was a really mess.

Your's looks very nice so I've got some questions:
Is there any option to exclude certain files?
Especially all patches as they are not part of the API, just scripts to update installation.
Maybe some of the internal libraries like PHPMailer, SMTP, etc
Also I think that every Install file seems useless for the developers.

It would be great if you would like to share a script to generate such documentation.

Regards,
Adam

cezar

Adam,

OK, I'll then try to generate documentation with excluded files you talk about. Also I think I'll exclude lang files, because they are technically just one big array and analysis of them is useless and took a lot of time - on my Intel i5 machine with 4GB RAM generation of Base documentation took 26 minutes. I'll also publish DOXYGEN config file I've used.

Please expect update today evening (CET time).

Cezar

ajb

Yes, in fact lang files are useless also. Maybe mine i7 with 8GB ram will get it faster.

Thanks for your involvement!

cezar

OK, I've uploaded new version of documentation witch doesn't contain too much garbage - at least I think so 😉 Please find it under: http://cichocki.com.pl/epesi/

I'm also including PDF file with DOXYGEN generated documentation - please think before printing, it contains 422 pages!

Cezar

cezar

Oooops, sorry - forum doesn't allow me to attach PDF files, so I've put documentation under this link: http://cichocki.com.pl/epesi/refman.pdf

cezar

And last but not least - DOXYGEN config file I've created for EPESI documentation, please find it here: http://cichocki.com.pl/epesi/Doxyfile-epesi

If you like to create your one, please install DOXYGEN and use

doxywiz

GUI wizard for fast and comfort tuning. In the config above I've excluded following directories: modules/Base/Lang/lang and modules/Base/patches. Thanks to it (mostly: excluding lang files) generation time has been reduced from 26 minutes to 45 seconds. Quite impressive :wink:

Cezar

ajb

Really thanks for this. I've tweaked this config to include all modules from the release and it's generated really fast.
I would like to publish this documentation on the epesi.org site and put a special thanks to you. Please send me a PM with a header you'd like to use (like "cezar <mail@example.com>" or "First Last" or anything else)

Regards,
Adam

cezar

Adam,

I'm more than happy that it was helpfull for great EPESI project! 😃

Cezar

Epesi ENS | Epesi Academy | epesi.cloud PaaS | GitHub

Help Me! | Download from SourceForge