Let's design a tool for editing and automatically generating patches for documentation to be included in IDL and header files.
Initial notes
- At the MoCo all-hands, we discussed ways to improve our reference documentation process, and the idea was proposed that we develop a tool that would pull an IDL or header file, let you edit it, test the JavaDoc HTML output, then let you submit a patch with a diff of the comments once you were finished in order to get edited comments into the tree. This would let writers work more or less directly in the headers and IDL files with a minimum of effort, and we could then switch to automatically generated reference documentation.
- See PyDocWeb as a possible inspiration.
- Can we do something where you edit WYSIWYG then get the comments regenerated?