The result with Moodle v2.9 is about 1.3 GiB. I have attached the Doxyfile I used which does not generate LaTeX, caller graphs, or callee graphs. Unlike PHPDocumentor, Doxygen runs quickly. # Insert /** */ as the second line of every PHP file. So I added this to each PHP file and then generated the Doxygen documentation, e.g., This line causes doxygen to generate the documentation for the functions, etc. I investigated why and realized that Moodle's PHP files don't have this markup line in them: /** */ Unfortunately, it only output class information when I first tried it. Since Doxygen works with PHP, I tried it with Moodle v2.9 stable. Personally I like Doxygen and use that myself with, for example, C++ code. Whether or not these are important, I don't know yet.) Doxygen (PHPDocumentor also emits an ENORMOUS number of warnings. For this reason, I would argue PHPDocumentor is an unacceptable solution unless it was run by someone and then posted online for all to use. For Moodle v2.9 it has been running for more than 24 hours and it is still not finished! So I cannot comment on its results yet except to say that PHPDocumentor is extremely slow to process Moodle's PHP. Unfortunately, there are no instructions I could find for this. While I do realize that only a small number of files really matter, there is still more than a handful of files: such really deserves to be generated into suitable documentation generated by individual programmers. Unfortunately, such is scattered across some ~7800 files. Nicely the PHP code does have comments with markup. (I am not complaining -just mentioning what one experiences if one is starting to do plugin development today rather than some years ago.)įor what I am coding, I really need an API reference -and there doesn't appear to be one online. Some even cause deprecation warnings to be emitted. Unfortunately, these examples are not complete with respect to the API (and there are no additional examples to make it more complete), and, many of the examples are out-of-date with respect to current stable Moodle. While this is wonderful, in several places Moodle developer pages say rather than dive into the minutiae of the API, examples will be presented. The online documentation is tutorial and/or overview oriented. This post is to share my experience doing this as there are other posts in these forums and elsewhere on the Internet asking about how to get API documentation -and those answers IMHO are unsatisfactory especially when compared to the instructions that appear below.Ī Comment About Current Online Developer Documentation Since I am unfamiliar with the APIs, this is not a realistic solution, so I thought I would build the documentation myself. Some posts (e.g., this forum) suggest using grep to look through the docs as a solution. There doesn't seem to be any current API documentation online at all. Unfortunately, I could find neither -all links, etc. I am starting to write some Moodle code and looked all over for (i) a location that I could see the actual API documented and/or (ii) instructions on how to officially generate such.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |