"Must have" features for a doc-generator
BlitzMax Forums/BlitzMax Programming/"Must have" features for a doc-generator
| ||
| Hi, my main project is growing and growing, so what I needed was a good solution to generate docs. I dont like BBDocs (to ugly, missing features) and HotDocs seams to be not updated any more (and missing features like indexing a single project) - so I'm doing my own: btDoX! The hard stuff is already done (Sourcecode-Lexer, global Indexing, basic HTML-Templateengine), and I'll start a worklog once I have some pics to show. btdoX takes a Two-Step approach: *generate XML-files from analysed sourcecode *generate HTML-files from the previously generated XML-files By generating xml-files from lexed .bmx-files everyone can use them to generate own docs (if the build-in templateengine is not enough), feed databases or do what he/she wants. btDox is completely project-based, so you can generate "global" Function/Type-References on as much/few .bmx-files as you like. I'm not sure if I release this for free, as donationware or charge a small fee. Once btDoX is complete, I'll have to make a decision, though I favor a donation-based model right now. I want to know what features you would want btDoX to have? What are you missing in the documentation-system you use right now? What would minimize your time-effort for documenting? Feel free to tell me what you want/think... |
| ||
| sounds good, but i hope btdoX is freeware, becouse i bought a license of Hotdocs. |
| ||
| I'll buy or donate it as the price is reasonable, and integrate well with BMax. Ioptional souce format thing, it should be good tho. |
   |