I'm looking for some kind of template I can use to easily and quickly document my own API. I don't mind if it's standalone software, a template for OpenOffice, a template for Dreamweaver or whatever, just something I can use to document my own functions. Note that I'm talking about a way of quickly and easily laying everything out and making it look a bit prettier. I don't want anything which automatically generates any documentation for me. ( It's not written in a language which would suit auto-documentation ) I want to write all my own documentation by hand, I just don't want to have to do all the laying out and beautifying, if I can help it.
It's only for my own personal use though, so I'm not looking to spend a great deal. If need be, I would write something myself read an XML input with the docs in and beautify it, I'm just looking to save a little time.
Edit Blitz3D command reference.
What development environment ?
For example in Visual Studio you add 'XML Comments' to each class, property and method. There are tags for summary, remarks, parameters, examples, code, see also etc.
You generate the documentation and there you have it. The output is web pages. You can edit the style sheets to tailor it a bit if you want.
Results are quite professional depending on what content you provide and how you use the tags. After all this is how much (all ?) documentation for the .Net API and many third party tools is created.
The same information is used by Intellisense so you see popups that present the summary and parameter contents just as it does when you use the .Net framework classes etc.
It is also most beneficial to have all of that documentation contained within the source. It helps you in understanding and modifying the API and you are more likely to keep the code and API in sync.
I'm pretty sure that any modern development environment such as Eclipse will provide the same sort of functionality.
As I said in my first post, I don't want the documentation generated for me.
I guess copying and pasting chunks of an existing piece of documentation like the B3D Command Ref and changing the text is possible, but I'd prefer something a little more elegant.