5 added option --header_breaks, which allows ROBODoc to insert line breaks
6 after every specified number of header names to improve readability.
9 o Merged path by Tom Keal that Fixes bug in parsing of the robodoc.rc file.
10 (The wrong number of items is recorded for the preformatted_items and
14 o Fixed bug 1706446, --sectionnameonly and --rtf format problem
15 o Fixed bug 1679101, "robodoc crashed on a faulty header".
16 o Added the option --no_subdirectories.
17 o output mode pipes at the end of an item don't result in broken
19 o Items that start with non-ascii characters are now recognized.
20 o makefile.plain works again
21 o the item names in the 'item order', 'ignore items', and other items blocks
22 in the robodoc.rc file are checked against the list of allowed item names.
23 o the options --sections and --toc do no longer lead
24 to an assert() with --ascii
25 o Added item sorting. The order in which items are to
26 appear in the documentation can be specified in the
31 o Removed form-feed from ASCII output
32 o Applied patch from Christian Vigh to make ROBODoc compile
34 o Applied patch from Wim van Hoydonck to fix a bug
35 in the escaping of '_' in the names internal artifacts
37 o Fixed makefile.plain
38 o ROBODoc compiles without warnings using
39 make -f makefile.plain
42 o Using bitfields in stead of and-ing with a define.
43 o Function name separator can be configured to be something
45 o Added a configuration block that allows the used to
46 specify which items are pre-formatted by default.
50 o Corrected return value of main()
54 o Improved Mac support (for FINK)
58 o Fixed many compiler warnings.
59 o More readable .css file
60 o makefile for mingw under cygwin
61 o Better syntax colouring support
64 o Moved most of the HTML formatting to the .css file
65 o Fixed a bug that caused the second list in a paragraph not
67 o Added more documentation to the source.
68 o Removed code for SGML docbook
69 o Removed makefile and project file for MS VC++
70 o Added functions to check for duplicate and
71 mutual exclusive options.
74 o Merged patch from Gergely Budai. (Adds syntax colouring, better
75 Latex output, and better tab control).
76 o changed output of --test format to xml. (Easier to parse).
77 o Masterindex no longer contains links to source files when
78 --one_file_per_header is used.
81 o Added option --one_file_per_header (experimental: this splits
82 the documentation into many files, one per header).
83 o Added header examples to documentation.
86 o Made it compile again under MingW
87 o Fixed a bug in the reporting of a missing robodoc.rc file
90 o Fixed crash on empty source items.
91 o Merged patch from cdumke for handling long lines
94 o Merged a patch from Friedrich Haase that allows '--src .'
95 and adds the options --sectionnameonly
96 o Merged a patch from Andreas Weder for better LaTeX output
97 o Added configuration options to allow some items
98 to work in the same way as a SOURCE item.
99 o ROBODoc now allows module and function names
100 that include white space.
104 o Added patch by Thierry Pierron for troff output.
107 o Documented more tests.
108 o Changed timestamp format.
109 o Added check on fork(). If fork() is not found only a stub for robohdrs
111 o Added patch by Thierry Pierron for aliasses. A single
112 header can now be used to documents several similar functions/
113 classes/variables etc.
117 o Fixed a bug in the compilation under mingw
121 o ROBODoc will look in different locations for the robodoc.rc file.
122 ( $HOME/robodoc.rc, $HOMEDRIVE$HOMEPATH/robodoc.rc, and
123 /usr/share/robodoc/robodoc.rc )
124 o Added option --nogeneratedwith to enable users to remove the
125 generated with robodoc line for the generated documentation.
126 o Fixed the makefile for mingw (thanks to Brian Elmegaard)
127 o Fixed a bug that caused robodoc to find headers even if
128 there were none. [1055886]
129 o Fixed a bug that caused robodoc to crash if single line source
130 item was found. [1056681]
133 o Fixed a bug that caused robodoc to crash when no files
138 o Fixed a bug that caused robodoc to die with an assert
139 when an absolute path is used under windows. [1033644]
140 o Updated the man page.
141 o Fixed a bug that caused links to be created for 'Foo' in
146 o If paths such as c:\doc\foo\bar are used as parameters
147 they are first translated to c:/doc/foo/bar before
148 they are further processed.
149 o Added patch send in by Ernst Bokkelkamp that adds
150 the header type to each headers documentation.
151 o Updated documentation.
154 o Merged a patch by Bernhard Schoenhammer that adds a
156 block to the robodoc.rc file.
157 o Solved bug [972456] Case problem with creating links.
158 o Fixed a bug [975543] that caused the Doc dir to be included when it was
159 a subdir of the sourcedir and the sourcedir was specified to
163 o Fixed XML DocBook output, it appears that 4.0.24 created
165 o Added smart formatting. Instead of using preformatted text,
166 that is copying the header text verbatim into the output document,
167 ROBODoc tries to determine the structure of the text from
168 the indentation and use of special characters.
175 Will be translated into the appropriate commands to create a similar
176 list in the output format.
180 o Added --headless and --footless option to create documents that can be
181 included into large documents. (Works for LaTeX and HTML).
185 o Added --nosort option
186 o With the define IGNORE_CASE_FILENAMES one can make robodoc case-insensitve
187 when it comes to filenames.
188 o Fixed bug [924530] False warning with empty lines
189 o Fixed bug [925920] broken robodoc.rc file; robodoc ignored end markers or
190 remark markers if there was no header marker block.
194 o When sorting module headers come before headers
196 o Fixes a bug in the sorting of headers.
197 o Fixes a bug in linking
198 o Sourcefiles that do not contain headers are not shown.
200 February 2004 - V4.0.21
202 o Added navigation bar for every header. It allows one to jump
203 to the parent header, the top of the document, and the index
205 o ROBODoc will continue parsing the other headers if it finds
206 a header it can not parse.
207 o Better formatted warnings.
208 o The sourcefile index is now always sorted
209 o Everything is sorted according to a non case sensitive string
212 January 2004 - V4.0.19
214 o Fixed bug 874567 No crosslinks for names that start with '-'
215 o Fixed bug 875533 No bolding for names starting with ::
216 o Added configurable header markers, remark markers,
217 and end markers. ROBODoc is now usable with
221 o Fixed broken configure on Solaris.
223 January 2004 - V4.0.18
225 o Update of the user manual and documentation
227 If you were using an 'extensions:' block in your robodoc.rc file,
228 you have to replace this with an 'ignore files:' block with all
229 extensions prefixed with '*'. So, if you were using
241 December 2003 - V4.0.17
243 o Added directory tree shaped master index for the sourcefiles.
244 o Added filtering of files and directories based on wildcard
247 o Support for lotus script, clean-up of headers.c and headers.h
249 December 2003 - V4.0.15
251 o Added support for DB/C
253 December 2003 - V4.0.14
255 o Bug fix. no index file was generated for headertypes of which
256 there were only internal headers.
260 December 2003 - V4.0.13
263 December 2003 - V4.0.12
265 o Updated makefile for borland C
266 o Added marker for Aspen Custom Modeller (ACM)
268 o Added more documentation
269 o a .css file is now also used in singledoc mode
270 o each header in the html documentation now has a permanent
271 "a name" based on the full name of a header.
272 o fixed the title of singledoc documents.
273 o files or directories specified with --src or --doc
274 are now automatically prefixed with a ./
275 o It is now allowed to have a Doc directory that is a subdirectory
276 of the source directory. This Doc directory is skipped while robodoc
277 scans for sourcefiles.
278 o Added headermarker !**** for Fortran
279 o ROBODoc now warns if it finds something that looks like an item name but is
280 not in the list of item names. This catches spelling mistakes like NAEM,
282 o Fixed bug 830868 no error message for misspelled options
283 o Fixed bug 767034 a slash at the end of a path confuses robodoc
284 o Fixed bug 772213 assert fires if header is not closed
285 o Added user configurable header types (section "header types"
287 o Added lock mode (--lock). Per source file robodoc locks on the
288 first headermarker it finds and will recognize only that particular headermarker
289 for the remaining part of the file.
290 In addition it locks on the first remark marker in each header and
291 will recognize only that particular remark marker for the remaining
294 o First implementation of piping in generator.c
296 September 2003 - V4.0.11
298 o Added a table for header types. This will allow custom
300 o The master index table for HTML output is split up in
301 several pages. One for each header type.
303 o added --version option
304 o fixed regex in bump.pl
306 September 2003 - V4.0.10
309 Augustus 2003 - V4.0.9
311 o Removed some obsolete functions.
312 o Added project file for MSVC++
313 o Merged patch from Brian P. Hanley:
314 + the option --rc to specify an alternate robodoc.rc file.
315 + the option --css to specify an alternate css file.
316 (The content of this file will be copied into the
319 Augustus 2003 - V4.0.8
324 o Indented all source code with indent
325 o Added markers for VB
326 o Added a Perl example to the Examples directory (bug 779560)
327 o Fixed layout of the man pages. (bug 779553)
329 o signed/unsigned char changes and UTF-8 output in SGML and DBXML modes
330 o robohdrs/-t option, macro (#define) created as `d' type header
334 o Added a makefile for Borland C compiler
336 o Fix for bug 761686, space in .rc file confuses robodoc
337 o Added a section on how to use robodoc under win32 to
339 o Fix for bug 770251, Absolute filename causes an assertion to fail
341 o Added a makefile for djgpp GCC under win32.
345 o Fix for bug 761688, rtf output goes only 4 sections deep.
346 o Added the option --tabsize n
347 o Lines that do not start with a remark marker are skipped,
348 unless they are part of a source item.
349 o Re-enabled ascii output.
352 o Fix for many compiler warnings.
356 o Merged changes to the html generator from Kai.
360 o Fix for bug -- ./configure crashes.
361 o Fix for bug -- Wrong version number is shown when compiled without using
365 o Added image: tag to html output.
368 o Fix for bug -- robodoc chokes on empty lines in
370 o Fix for bug -- Bad formatting of the 'unknown section' error.
371 o Fix for bug 721685 -- TOC appears twice in a RTF Doc
372 o Fix for bug 721690 -- TOC in mutidoc files are wrong.
373 o Added support for DCL.
376 o Fix for bug 715778 -- on some machines the d_type of the
377 struct dirent is always DT_UNKNOWN. This caused ROBODoc
378 to skip all files. (Thanks to Je'rome Laheurte).
379 o Merged a patch by Andreas Signer that add a number of
381 o Merged a patch by Janusz Piwowarski that allows users
382 to specify (1) the extension of the output file and
383 (2) html character encoding.
386 o Support for XML DocBook output.
387 o A new tool, robohdrs, is included -- it can insert empty headers
389 o Support for cascading style sheets (CSS) in HTML mode.
390 o Complete rework of the commandline interface.
391 o ROBODoc can now work with directories and subdirectories,
392 and does not need xref files anymore.
393 o All documentation can be created with a single command, you
394 no longer need a makefile to create your documentation.
395 o The manual is now in docbook format and much more extensive.
396 o Lots of refactoring, code should be easier to extend and understand
398 o There is now some design documentation.
399 o Support for single file and multiple file documentation.
400 o Dropped support for Amiga Guide format.
402 o Support for packaging under RedHat and OS-X
403 o C++ and C examples have been removed.
407 o 2 character header types
408 Modifications by Nathan Prewitt
409 o To allow further classification
410 of internal headers as internal functions, internal classes,
411 internal variables, etc.
412 o Added export into TROFF format with man macros -
413 suitable for Unix man pages.
414 o Fixed HTML generation to skip table of contents
415 if there were no TOC requested at command line.
416 o Fixed analyzer to correctly handle empty headers.
418 March 2002 - Frans Slothouber (V3.2.4Beta2)
420 o Documentation update
421 o Added automatic detection of file:/
422 o Merged back the changes by Sasha Vasko.after I had
423 accidently deleted them when merging the DocBook changes.
424 o Indented most of the sourcecode.
426 March 2002 - Frans Slothouber (V3.2.4Beta1)
427 o Documentation updates.
428 o added a target docclean in the makefile in Source/ to clean
430 o updated documentation
431 o added testframework
433 August 2001 DCD Changes - V3.2.4 with docbook support:
434 o Added support for Docbook SGML - Robodoc can now produce
435 output in Docbook SGML using the DBSGML command line switch,
436 allowing standardized conversion to a host of formats
437 including HTML (single and multiple), RTF, ASCII, LATEX,
438 and PDF. Docbook also
439 allows you to use external style sheets in which you can
440 change the look of your document. See www.docbook.org for more
442 o Added -rh switch which causes Robodoc to scan for a single header
443 defined as *ROBODOC* (char *robo_header) instead of header_markers
444 and uses *ROBODOC_END* as the end marker.
445 This prevents problems with Robodoc becoming confused with
446 normal comments uing *. It is particularly helpful in scanning
447 PHP source. It will only work with languages that support
448 multiline c-style comments
449 o Added -nt switch. Only used in DBSGML mode when creating a master
450 index. This causes Robodoc to list the Master Index functions as
451 a section 3 level item rather than as part of a table.
452 o Added genrd, a Unix bash shell script which simplifies the use
453 of Robodoc when generating documents from multiple source files
454 and when creating crossreferences and a master index.
455 Whole directories and subdirectories of source code can be
456 scanned and documented with a one line statement rather than
457 having to construct a makefile or using multiple
458 robodoc statements. See genrd -h for more info.
460 Sepetember 2000 - Frans Slothouber (V3.2.3)
461 o Added a descrip.mms file for compilation under VMS
462 o make install installs additional documentation.
463 o Fixed a bug that caused links of the type
464 "someword/anotherword," to be ignored, while
465 "someword/anotherword" was recognized.
467 July 2000 - Frans Slothouber (V3.2.2)
468 o Documentation explains how to use ROBODoc when your sources are
469 in several subdirectories.
470 o Documentation explains master index file for LaTeX, how to view
471 the generated documentation, and the new options, NOSOURCE, SINGLEDOC
473 o example makefile includes commands to view the
474 generated documentation.
475 o Updated the man page
476 o Added option SINGLEDOC
477 For LaTeX output this generates documentation without
478 the start and end headers. This way the generated file
479 can be included in a master file.
480 o Added master index file for LaTeX output. The documentation
481 gathered from several source files can now be included into
483 o Added the option NOSOURCE. With this option the SOURCE item
484 is not included in the documentation.
485 o Added the TITLE option. This allows to set the title for
486 the master index file.
487 o Made the search for headermarkers case insensitve.
490 December 1999 - v3.1f
491 o added RB_TimeStamp() to include time stamps in the documentation.
492 o Documentation is now generated in LaTeX2e format.
493 o added '|****' as begin marker, '|' as remark marker and '|***' as
494 end marker for GNU assembler support.
495 o ran ident on all source. Using the GNU standard now.
496 o Added new fold markers provided by Petteri
498 December 1999 - Frans Slothouber (v3.1e)
499 o Moved the C example in Examples to Examples/C
500 o Added an C++ example in Examples/CPP
501 o Added empty headers for C++ in Headers/
502 o More documentation.
503 o added markers for HTML.
504 o modified the RB_Find_Link() function to also words that include
505 "::". This is used for C++ methods.
506 o added a RB_Function_Name() function that correctly extracts the
507 function name (or the name of any other object that is documented)
508 from the header name. The old code used RB_FilePart which failed
510 o Fixed a core-dumping bug in RB_Set_Doc_Base()
512 December 1999 - Frans Slothouber (v3.1d)
513 o Added list of possible item names to the robodoc man page.
514 o Added list of possible header types to the robodoc man page.
515 o Updated manual with information on the generation of the
516 master index file and new header types.
517 o added new header types for, classes, methods, variables,
518 functions, strutures and constants. (Idea of Stefan Kost)
519 o added a command to create a master index file that contains
520 sorted pointers to all classes, methods, variables,
521 functions, strutures and constants.
523 December 1999 - Frans Slothouber (v3.1c)
524 o Added testheader.c for debug purposes.
525 o Split the source code into serveral files.
526 o Fixed numerous typos in the documentation.
527 o Using m4 to create the html documentation (for table of contents ect).
528 o Added cross links between the documentation and examples.
529 From patches that I received from Stefan Kost
530 o renamed BEAST METHODS -> METHODS
531 o renamed BEAST ATTRIBUTES -> ATTRIBUTES
532 o added new items useful for object oriented programming; some of
533 these items are already used in os3.1 autodocs
534 TAGS, COMMANDS, DERIVED FROM, DERIVED BY, USES,
535 CHILDREN, USED BY, PARENTS, USAGE, PURPOSE
536 o commented the item names
537 o changed item-type enums to end all with _ITEM
538 o changed RB_Find_Link to accept names ending with '...'
539 o changed copyright comment to be a style-guide conform version string.
540 o changed RB_VER[] to be a style-guide conform version string
541 o changed AMIGA into _AMIGA, because the first one does not exists,
542 when compiling with NOANSI on SAS C/C++
544 November 1999 - Frans Slothouber (v3.1b)
546 o Cleaned-up html documentation.
547 o <A NAME="source code file name"> is generated at the beginning of
548 each document. A mention of the source code name in another
549 document creates a link to this name (provided you use xrefs).
550 o Moved most #defines and enums to robodoc.h
551 o Made ROBODoc more forgiving in reading the xrefs file. Empty
552 lines are allowed and also spaces at the end of a file name.
554 August 1999 - Frans Slothouber: v3.1
556 o Added INSTALL, README, and TODO
557 o Converted the documentation to HTML
558 o Spell-checked all documentation
559 o More documentation and a more informative usage() function.
560 o robodoc -c prints licence
561 o removed a number of Source items from the documentation to reduce
562 the size of the robodoc.c.html file... no fun for people
563 to download a >100k file.
564 o removed the warning about not using a robodoc default file.
565 o indent -orig -i2 -nbc -ncdb -bad -bap
566 o Fixed the warnings.
567 o Fixed some occurrences of (evil cast)malloc (thou shalt not
569 o ROBODoc now returns EXIT_FAILURE or EXIT_SUCCESS, as defined
571 o Fixed a memory leak in RB_Analyse_Document()
573 Modifications by Petteri Kettunen
575 o Support for folding in SOURCE items, HTML only.
577 o Added options FOLD and C
579 Modifications by Petteri Kettunen
581 o Changed background color to white
582 o Changed size of Table of Contents title. (H3 instead of H1)
583 o The reverse function also reversed the sorted header list,
586 Modifications by FNC Slothouber.
587 Feb-1999 - v3.0l * Added function to reverse the header list.
588 14-Aug-1998 - v3.0k * Tcl/Tk '#' handling added;
593 o cleaned the HTML-output, so it now conforms to the DTD for HTML-3.2
594 o TOC now is an ordered list (<OL> and <LI>)
595 o added "<!DOCTYPE..>"
596 o added quotes to values of some HTML-attributes
597 o more compatible implementation of the SGML-comment containing
598 copyright-info replaced all occurrences of <B><PRE>.. by <PRE><B>
599 o replaced <H2/3> by <H1/2>
600 o fixed two minor warnings reported by gcc -Wall
602 Modifications by FNC Slothouber.
604 o Bug Fix, Both the options INTERNAL and INTERNALONLY did not
606 01-April-1996 - v3.0h
607 o Added ';' to > and < so lynx also recognizes them.
608 o Fancied up the HTML output.
610 Modifications by apang
612 o Cleaner build for Borland C++ 4.52
613 o Added more markers (C++, Pascal, Modula-2, COBOL)
614 o Added more item types/names
615 o Added #defines for the preamble (COMMENT_ROBODOC and
617 o BLANK_HEADER for detection of asterisk'd lines
618 o RB_Say() the GENERIC header warning instead of using printf()
619 o Indents SOURCE body in output
620 o ASCII respects the TOC flag; removed extraneous newline after
621 formfeed (so it's more like AutoDoc)
622 o HTML output fixed to handle '<', '>', and '&'
623 o LaTeX attributes and '%' handling added; fancied up the output a bit
625 o Changed some fprintf()'s to fputc()'s for potentially lower overhead
626 o Fixed line eater bug
627 o More general fix to the TOC problem of including internal links
628 when it wasn't selected
630 Modifications by FNC Slothouber.
632 o fixed the problem with the TOC that included links to headers that
633 were not selected. (i.e internal)
639 o Fixed a bug with the defaults file
640 o Improved search algorithm RoboDoc is now 5.8 times faster.
642 o New scanner that searches for a set default markers
643 that define what is a comment or what is not and that
644 define what or what is not a header/end marker.
645 o Added Beast Support
647 08-Aug-1995 - Koessi -
648 o a lot of while instead of for
649 o a lot of switch() instead of ifelse
651 o RB_Say, RB_Panic now useable like printf()
652 o new formats for nearly all output-strings
653 o char *whoami is global copy of argv[0]
654 o BOLD <- MAKE_LARGE && AMIGAGUIDE
655 o succesfully compiled&tested on HPUX (HP9000/800)
656 o optimized listfunctions
657 o encapsulated header- and link- allocating and freeing
658 o RB_Find_Function_Name() replaced with RB_FilePart()
660 07-Aug-1995 - Koessi -
661 o automated foldmarks "\***"
662 o ! GoldEd's foldmarks == RoboDoc marker !
663 o quoted source parsing enhanced
665 01-Aug-1995 - Koessi - v2.0?
666 o more robust parsing, less enforcer-hits
667 o removed self-referencing links !
668 o remarked most changes with *koessi*
669 o added GoldEd-foldmarks
670 o compiled successfully with SAS-C 6.3
672 24-May-1995 - Frans Slothouber - v2.0e
673 o Fixed a bug that cause the CleanUp Routine to lock up.
674 o Improved the HTML output, should work faster now.
676 15-May-1995 - Frans Slothouber - v2.0d
678 o Added Verbose option.
680 12-May-1995 - Frans Slothouber - v2.0c
683 10-May-1995 - Frans Slothouber - v2.0a
684 o Program completely rewritten
685 o added SOURCE item and LaTeX output.
686 o added TAB converter.
688 20-Apr-95 - Jacco van Weert - v1.1a:
689 o INTERNALONLY option added.
690 o Sort problem solved.
692 2-Apr-95 - Jacco van Weert - v1.0b: Bug fixes
693 o Procedure header search bug solved.
694 o Print 'created procedure' text
696 Mar-95 - Jacco van Weert - v1.0a: Final version
698 2-Feb-95 - Jacco van Weert - v0.93:
699 o Mungwall hit, solved.
700 o When item headers, are also available in body then parts are
703 26-Jan-95 - v0.92: 2nd test beta-version
705 19-January-95 - Jacco van Weert (v0.8)
706 o First test beta-version
708 December 1994 - Jacco van Weert -- creation date.