[sr-dev] git:master: - Doxygen updates on core files

[Jan Janak]

On Tue, Oct 20, 2009 at 8:09 PM, Olle E. Johansson <oej at edvina.net> wrote:
>
> 20 okt 2009 kl. 16.48 skrev Jan Janak:
>
>> On Tue, Oct 20, 2009 at 2:34 PM, Andrei Pelinescu-Onciul
>> <andrei at iptel.org> wrote:
>>>
>>> P.S.: just a tip for people who don't know it yet: all the doxygen
>>> documentation is auto-generated  from the latest code and can be
>>> accessed under http://sip-router.org/doxygen/sip-router/branch/master
>>> Same goes for modules/core user docs:
>>> http://sip-router.org/docbook/sip-router/branch/master/
>>
>> Just a little side note. The scripts which generate this DO NOT use
>> the doxygen configuration file in sip-router/doc/doxygen. Hence,
>> making changes to the configuration file will not alter the look and
>> feel of the automatically generated documentation.
>>
>> If you want to re-configure how the auto-generated doxygen
>> documentation looks like, please let me know.
>
> Well, the changes I've done in the configuration is that we take a few
> parameters
> from the Makefile now, to make sure that we always have the right product
> name
> and version in the doxygen documentation.

As for name, it should be the neutral "sip-router" in the online
documentation. And regarding version, the script which updates online
documentation retrieves the current version from the git repository,
the result looks like this:

2.99.99-git20091020.f790040

Because we update the online document automatically every 15 minutes
or so, the version string includes the git revision so that we could
see what commit does the documentation refer to.

> I was looking into including the
> logo you made too, but that's not a priority.

That's a good idea, I'll see what I can do.

  -- Jan