[OpenAFS-devel] Doxygen

[Jason Edgecombe]

On 09/16/2012 09:09 PM, Jeffrey Altman wrote:
> On 9/16/2012 5:42 PM, Russ Allbery wrote:
>> Jason Edgecombe <jason@rampaginggeek.com> writes:
>>
>>> Do we need one unified doxygen build for src and doc, or split them up as
>>> separate runs of doxygen?
>>> In other words, what should the final output look like?
>> I think it should be unified.  In the long run, I think that the files in
>> doc should be moved into somewhere reasonable in the source tree to make
>> it easier to do a complete Doxygen run.
>
> The protocol docs are a replacement for the files in doc/pdf that were
> originally written back in the early 90s.   There is a reasonable
> argument to be made that since the protocol is independent of the
> OpenAFS implementation that it should be built separately.
>
> The architecture docs I agree should be moved into the src tree so that
> they can be more easily built into the same output document as the rest
> of the source documentation.
>
> Feel free to submit a patch that makes that happen once you figure out
> what works best.
>
> Jeffrey Altman
>
>
I have a basic doxygen config. I've moved some of the specifications to 
their own module.

I've pushed three patches to gerrit:
http://gerrit.openafs.org/8128
http://gerrit.openafs.org/8129
http://gerrit.openafs.org/8130