Commit graph

12 commits

Author SHA1 Message Date
turleypol
d3a300aef9 added missing objreference documentation eg. complete xml objects. 2019-11-10 11:29:19 +01:00
turleypol
73890662a9 silence old core-changes.txt format warnings 2018-11-25 11:10:10 +01:00
Gabriele Tozzi
63ec22f1ca Allow buildcorechanges.py to be invoked from any path 2018-04-02 15:52:25 +02:00
Gabriele Tozzi
88d7c84b6f Updating doc version to POL100 2018-02-11 00:01:46 +01:00
turleypol
de391f0940 check in both directions for member and methods 2017-08-16 22:13:14 +02:00
turleypol
2a3b83fd9b extended noob way to parse cpp files
corrected a few docs
removed senseless method check in cpp
2017-08-15 20:39:22 +02:00
turleypol
9a7f0e58d3 Wrote a very simple parser to check obj members/methods, atleast found a
few missing/wrong entries
2017-08-15 14:48:14 +02:00
Gabriele Tozzi
d1ac902926 Documentation: reformatted headers for DoxyGen 2016-01-28 14:52:40 +01:00
Gabriele Tozzi
108ebfbd9d Documentation: drafting a script to reformat e-script guide 2015-12-13 13:40:23 +01:00
Gabriele Tozzi
405d25aeff Fixed: minor fix in the new buildcorechanges.py to work on Windows 2015-09-03 07:42:22 +02:00
Gabriele Tozzi
aad0037dca Documentation: sync EScript Modules documentation with em files
Also added a new tool checkem.py in "doctools" folder: it helps
checking wether em and xml files are in sync or no.

This is a quite accurate job: I'm almost 100% sure (thanks to
checkem.py) that:
- All the functions defined in .em files are now mentioned in docs
  (except of deprecated ones that i omitted on purpose)
- Function prototypes are the same in .em files and their doc
- All the function arguments have at least a basic doc element
- All the constants defined in .em files are in the docs

A 2nd round of review would be probably useful tought, expecially
on uoem.xml, who had the major changes: I didn't go deep into
what every function does and maybe some slightly changed their
behaviour during these years. This should be a more than good start
anyway: if there are some errors left, hope somebody will notice
and report them :)
2015-09-02 03:06:36 +02:00
Gabriele Tozzi
4fc4efa423 Documentation: syncing core changex XML with TXT, new automatic tool
The sync now goes back to POL095 era... after that, the format is
completely different and would require writing a 2nd dedicated
parser: I think it's not worth it.

The automatic parser is buildcorechanges.py and is located in a new
"doctools" folder. A real dev may move that folder later where he
will think it is more appropriate.

Parser tested only on Linux, but I wrote it to also work on Windows.
2015-09-02 02:57:20 +02:00