search

omeka / omeka-s-developer

Documentation for Omeka S developers
Other
19 stars 37 forks source link

Question the generated documentation #24

Closed patrickmj closed 6 years ago

patrickmj commented 7 years ago

Generated documentation seems to be having diminishing returns since last investigated.

ApiGen is looking for a new maintainer. It's been painful and unsuccessful to revert back to the version that generated what we currently have. The latest fixes bugs, but eats up memory like crazy. It got 2% through the process, and had used up more than 25 GB of memory/swap. That puts us at needing more than a TB of memory to generate docs using it, unless my arithmetic is way off (always a possibility).

The fallback would be to look again at PHPDocumentor, which we didn't like much based on the output. It's had more activity lately, but we'd have to see if it runs through okay.

patrickmj commented 7 years ago

Alternate approach: Babysit just running it on each top level src directory (Api, Controllers, etc.). Then write a manual wrapper around those. That'd get the high-level view of what's relevant and how they (classes, interfaces, etc) connect, with some loss, but still make it visible for new developers to explore from a high-level perspective.