ROBODoc

ROBODoc 4.99.32 Released

2007-05-30T12:04:00.000+02:00

I am pleased to announce that ROBODoc 4.99.32 has been released.

ROBODoc wiki

2007-02-18T21:51:00.000+01:00

My Internet provider offered a free wiki. That was an offer I couldn't refuse. So now ROBODoc has a wiki.
Nothing there yet, but that will change.

Plans for 4.99.32

2007-02-08T23:25:00.000+01:00

In 4.99.32 it will be possible to specify the order in which items are to appear in the documentation. For instance, given the header:

 /****f* Test/test
 * NAME
 *   Test
 * FUNCTION
 *   Does a test.
 * EXAMPLE
 *   test()
 * SOURCE
 *
void test( void )
/*****/

and a robodoc.rc file that includes:

item order:
  NAME
  SOURCE

The documentation will look like this:

NAME
 Test
SOURCE
 void test( void )
FUNCTION
 Does a test.
EXAMPLE
 test()

ROBODoc 4.99.30 Released

2007-02-07T23:13:00.000+01:00

I am pleased to announce a new version of ROBODoc, V4.99.30. The main focus of this release is configurability and all the enhancements have been made by Gergely Budai. Many thanks to him!

ROBODoc V4.99.28 released

2006-08-30T16:03:00.000+02:00

ROBODoc V4.99.28 has been released.

You can find it either on the ROBODoc homepage or on sourceforge.

Many thanks go to Gergely Budai who greatly improved the navigatability of the HTML documentation that ROBODoc generates. More improvements are on their way.

New layout for 4.99.28

2006-08-28T10:29:00.000+02:00

ROBODoc V4.99.28 is about to be released. The main visable change is the new layout for HTML documentation ROBODoc generates. I tried a few different layouts but settled on this one. It is based on a layout created with a nice layout generator called strange banana.

A different ROBODoc

2006-07-12T23:30:00.000+02:00

ROBODOC the movie. Totally unrelated but looks like fun.

Plans for ROBODoc V4.99.28

2006-07-12T12:16:00.000+02:00

The current layout of the HTML documentation generated with ROBODoc is getting outdated. It uses hardcoded tables for the layout for instance.

The plan for version V4.99.28 is to move all the layout information to the robodoc.css file. This gives users much more control over the layout because this file can be replaced with a user's version with the --css option.

I also hope using css for the layout gives the documentation a more modern look too. To see if you agree have a look at a preview of the new layout. It uses some nice techniques created by Alessandro Fulciniti.

Tags: ROBODoc

Overview of programs similar to ROBODoc.

2006-07-07T00:35:00.000+02:00

Over at //engtech there is a nice overview of programs similar to ROBODoc. Choice is good.

(Well actuall too much choice can be bad.)

Support for MS VC++ dropped

2006-07-03T16:48:00.000+02:00

The possibility to compile ROBODoc with MS VC++ will be removed in V4.99.28. The reason for this is that MS VC++ is too limited in comparison to gcc under cygwin. This way functions like fork() and snprintf() can be used without having to worry about how to still get everything compiled under MS VC++.

One file per header

2006-07-03T12:22:00.000+02:00

ROBODoc has three output modes. These are specified with the options --multidoc, --singledoc and -singlefile. These modes determine how source files map unto documentation files.

The most simple mode is singlefile. In this mode a single source file is mapped unto a single documentation file. If you have a source file main.c with a couple of headers, these headers are extracted and stored in the documentation file main_c.html. Singlefile mode is mainly useful for testing.

In singledoc mode the documentation extracted from all your source files found in a directory tree are stored in a single documentation file. This is useful for smaller projects.

In multidoc mode the documentation extracted from all your source files found in a directory tree are stored in several different documentation files. For this a mirror is made of the whole source directory tree and for every source file a documentation file is created. This works well for bigger projects. It does place some requirements on the structure of the source tree. Source files should be small and the directory tree logically structured.

None of these modes work well for a project source consists of only a few but giant source files. The resulting documentation files are now slow to load and difficult to browse.

However with the new option --one_file_per_header in 4.99.26, ROBODoc can handle this kind of projects too. Use this option combination with --multidoc and ROBODoc creates an individual documentation file for every header found in any of the sources files.

For an example follow this link.

ROBODoc 4.99.26 released

2006-06-28T12:20:00.000+02:00

Just released ROBODoc 4.99.26. The main change in this release is the patch I got from Gergely Budai (thuffir). His patch adds a whole string of new options (See this sourceforge item). Most of them still have to be documented in the manual though. But this way he can work on more improvements.

Plans for the next releases

2006-06-20T23:26:00.000+02:00

Currently working on integrating all the patches and enhancements that people have sent over the past months. A very nice one is the one made by sourceforge user thuffir. His patch contains many improvements, but the one I like best is the syntax colouring for C. For an example this see this function.

ROBODoc 4.99.24 released

2006-06-18T10:27:00.000+02:00

Just released version 4.99.24. You can find an precompiled executable on this page. The sources can be downloaded from this page. On the TODO list for the following releases is integrating the back-log of patches and ideas for improvements that I've received in the previous months.

No more beta-releases

2006-06-13T09:11:00.000+02:00

I have decided to no longer release beta-releases. The beta-releases gives me an excuse not to release a stable-release and results in long intervals between stable-releases. Every release will now be a stable-release. Given the amount of unittests this should not be a problem.

new option --one_file_per_header

2006-06-07T17:00:00.000+02:00

Working on a new option called --one_file_per_header.
This option causes ROBODoc to split the documentation of a single source files into several documentation files, one documentation file per header. This makes working with very large source files easier. This has been requested by several people.