Make Doc format chage suggestion

BlitzMax Forums/BlitzMax Module Tweaks/Make Doc format chage suggestion

Jay Kyburz

(Posted 2005) [#1]

I've been using Spotlight and Google Desktop to search my blitz max documentation. Unfortunately all the html files are called commands.html, making it difficult to select the right one.

Not a big deal but something to keep in mind if ever changes are made to this system.

MrCredo

(Posted 2005) [#2]

hm... hotdocs could help you?

this program generate one file for each command/variable...

Russell

(Posted 2005) [#3]

I wonder how much trouble it would be to convert the html-based docs into a searchable format, like .hlp or .chm (windows) or .pdf (everyone)?

Russell

Jay Kyburz

(Posted 2005) [#4]

yeah but the whole hotdog / hotdoc thing kind or creeps me out.

N	(Posted 2005) [#5]

I prefer Doxygen style documentation.

e.g.,

''' @brief Does something
''' Does something incredibly useless
''' @param argA Something!
''' @param argB Something else!
Function Name( argA, argB, argC )

I wrote a documentation generator that handles it, problem is nobody would adopt its use.