[PATCH] libpayload: expand Doxygen definitions

[Jordan Crouse]

This patch does some Doxygen housekeeping and starts to expand
the definitions in libpayload.h.

[Stefan Reinauer]

Jordan Crouse wrote:
> libpayload:  Expand doxygen definitions
>
> Expand libpayload.h to include a main page and add individual 
> groups for the API functions - this adds the "Modules" tab to
> the doxygen output.
>
> Specify the INPUT list rather then the EXCLUDE list of directories
> to omit random .c files that we don't want.  Add clean targets to
> the makefile to clean doxygen files only.
>
> Signed-off-by: Jordan Crouse

Acked-by: Stefan Reinauer

libpayload: expand Doxygen definitions

[Jordan Crouse]

On 28/08/08 18:47 +0200, Stefan Reinauer wrote:
> Jordan Crouse wrote:
> > libpayload:  Expand doxygen definitions
> >
> > Expand libpayload.h to include a main page and add individual 
> > groups for the API functions - this adds the "Modules" tab to
> > the doxygen output.
> >
> > Specify the INPUT list rather then the EXCLUDE list of directories
> > to omit random .c files that we don't want.  Add clean targets to
> > the makefile to clean doxygen files only.
> >
> > Signed-off-by: Jordan Crouse
>
> Acked-by: Stefan Reinauer

r3545 - I also fixed a little bug I found in one of the modules.
I'm going to try to update the documentation on a regular basis until
we are caught up - I propose that these are suitable for self-ack to
avoid bothering everybody.  Thoughts?

Jordan

libpayload: expand Doxygen definitions

[Stefan Reinauer]

Jordan Crouse wrote:
> r3545 - I also fixed a little bug I found in one of the modules.
> I'm going to try to update the documentation on a regular basis until
> we are caught up

Awesome! Thanks for doing this.
> I propose that these are suitable for self-ack to avoid bothering everybody.

I fully agree. Adding documentation is also not going to break anything.

Stefan

libpayload: expand Doxygen definitions

[Jordan Crouse]

On 28/08/08 18:59 +0200, Stefan Reinauer wrote:
> Jordan Crouse wrote:
> > r3545 - I also fixed a little bug I found in one of the modules.
> > I'm going to try to update the documentation on a regular basis until
> > we are caught up
>
> Awesome! Thanks for doing this.

Its not fun, but its needed.  I think its pretty important to heavily
document the external functions of libpayload as much as possible. It
would really help if you can set it up so the documents get automatically
updated somewhere on coreboot.org.

While we're talking about it - I want to document the external functions,
but I'm not nearly as interested in documenting the internal functions,
in fact, I've been considering turning off EXPORT_ALL in the doxygen file,
and only documenting the external facing functions.

Thoughts on this?
> > I propose that these are suitable for self-ack to avoid bothering everybody.
>
> I fully agree. Adding documentation is also not going to break anything.

Thanks.

Jordan

libpayload: expand Doxygen definitions

[Stefan Reinauer]

Jordan Crouse wrote:
> Its not fun, but its needed.  I think its pretty important to heavily
> document the external functions of libpayload as much as possible. It
> would really help if you can set it up so the documents get automatically
> updated somewhere on coreboot.org.

http://qa.coreboot.org/docs/libpayload/

It's updated every 5 checkins.

libpayload: expand Doxygen definitions

[Jordan Crouse]

On 28/08/08 21:39 +0200, Stefan Reinauer wrote:
> Jordan Crouse wrote:
> > Its not fun, but its needed.  I think its pretty important to heavily
> > document the external functions of libpayload as much as possible. It
> > would really help if you can set it up so the documents get automatically
> > updated somewhere on coreboot.org.
>
> http://qa.coreboot.org/docs/libpayload/
>
> It's updated every 5 checkins.

Thank you kindly - wiki updated.
>