302981 - [doxygen] need doxygen configured to generate XML output nightly on giles

Status: RESOLVED FIXED

(developer.mozilla.org Graveyard :: General, defect)

Description

[Deb Richardson [:dria] (plz NEEDINFO)]

Excerpting part of shaver's email here as a list of things that need to be done
towards integrating Doxygen into the Devmo wiki...

****
- get someone to set up a doxygen job that runs nightly or whatever and produces
the XML output somewhere on giles

- make that somewhere web-visible, perhaps as /devmo/docxml-temp, so that people
can C&P from it into the wiki. 
****

Comment 1

[Alex Polvi]

> - get someone to set up a doxygen job that runs nightly or whatever and produces
> the XML output somewhere on giles

Are there any more details on what we are doing here? Is this extension based?

Comment 2

[Deb Richardson [:dria] (plz NEEDINFO)]

Shaver has been working on a wiki extension that will allow us to easily
integrate doxygen output into the wiki.  I don't know a whole lot more than that
at this point.

Comment 3

[Benjamin Smedberg]

I really don't think that we should be running this daily or even weekly: I
think that we should run the doxygen thing once per release (about the time we
release 1.8, for example, and 1.9, etc). Maintaining doxydocs for the inbetween
times between releases sounds painful and silly.

Comment 4

[Christian :Biesinger (don't email me, ping me on IRC)]

bsmedberg: I think that's not often enough. what about extension authors wanting
to update their extension for the release? "About the time of the release" is
not that good, then.

Comment 5

[Alex Polvi]

(In reply to comment #2)
> Shaver has been working on a wiki extension that will allow us to easily
> integrate doxygen output into the wiki.  I don't know a whole lot more than that
> at this point.

What do I need to do to help? Setup doxygen to run against all mozilla code and
put the output on giles?

Comment 6

[Mike Shaver (:shaver emeritus)]

Resummarizing for my sanity.

We want to do frequent updates, because we don't want people saying "I can't fix
the docs for this API change that just happened until 1.9 ships and we
regenerate the doxygen output".  Short feedback cycles are what we're all about.

Comment 7

[Justin Wood (:Callek)]

bsmedberg, I think weekly may even be too "long" of a wait, every 2 days at the
least imho.

At least in the unfrozen tree state, what about 'new' core developers who need
to figure out what an interface does, they would look at the devmo Doc on the
interface, having up-to-date doxygen docs is a *good* idea.

This also makes sense when we set-up/configure a/the extension to "suggest"
doxygen changes (as in what is actually commented in the file).  For the cases
of typo's or innaccuracies.

I would much rather defer on the attempt for up-to-date docs, then
not-up-to-date.  If up-to-date is not an issue, then we can simply import the
doxygen stuff once, and (try to) encourage people to update the wiki each time
they update a file.  What is the use with anything importing doxygen output if
we do that?
[/semi-rant]

Comment 8

[Deb Richardson [:dria] (plz NEEDINFO)]

Could we please get an ETA on this?  Polvi: do you need any more information to
proceed here?

Comment 9

[Alex Polvi]

Shaver mentioned looking in to a different extension to do the same job. This
one looks like it is going to be a pain to maintain a custom RPM. Shaver, any
thoughts?

Comment 10

[Alex Polvi]

That last comment was meant for 302983.

doxygen is already installed on giles. I have gotten the impression that we are
using doxygen to parse Mozilla source code and output documentation. Is that
correct? If so, which products are we doing this with? 

Comment 11

[Mike Shaver (:shaver emeritus)]

I can configure doxygen.  Can you set up a cron to do a nightly pull of the
tree, and run doxygen on it?  (Leave the latter disabled until I put my config
file in place, or we'll destroy poor giles with the default settings.)

Once you do that, reassign this to me.

Comment 12

[Alex Polvi]

Have at it! 

/etc/cron.daily/doxy-run.sh 

doxygen setup is up to you. If you need any further help let me know.

Comment 13

[Mike Shaver (:shaver emeritus)]

Done, in /etc/cron.daily/doxy-run.sh.