[libcamera-devel] documentation?

[David Plowman]

Hi Laurent

I see no improvement in either the latest source release (1.8.19) or
git master branch (calls itself 1.9.0).

For now I'll just document all the enum values in the main text body,
and make do without the hyperlinks. It's easy enough to switch back
when things have been fixed.

David

On Thu, 20 Aug 2020 at 11:19, Laurent Pinchart
<laurent.pinchart at ideasonboard.com> wrote:
>
> Hi David,
>
> On Wed, Aug 19, 2020 at 09:53:42PM +0100, David Plowman wrote:
> > Hi again
> >
> > So one more problem with this. Has anyone successfully documented a
> > strongly-typed enum ("enum class") before? I can't get the
> > "Enumerator" list - a table which describes all the values the enum
> > can take - to show up.
> >
> > Here's an example. In my (cut down) .h file I have:
> >
> > enum class Transform1 {
> > Identity1 = 0
> > };
> >
> > enum Transform2 {
> > Identity2 = 0
> > };
> >
> > and in the .cpp file I have:
> >
> > /**
> >  * \enum Transform1
> >  * \brief Define the data type Transform1
> >  *
> >  * Stuff.
> >  *
> >  * \var Identity1
> >  * A value.
> >  */
> >
> > /**
> >  * \enum Transform2
> >  * \brief Define the data type Transform2
> >  *
> >  * More stuff.
> >  *
> >  * \var Identity2
> >  * Another value.
> >  */
> >
> > In the case of Transform2, everything is fine, the enumerator list
> > shows up. But in the case of Transform1 - no description of Identity1.
> > I can always type the descriptions out without the "automatic" table,
> > though I miss out on some hyperlinks. Anyone have a better idea or
> > workaround? (I appear to be running Doxygen 1.8.13, in case that
> > matters.)
>
> Would you be able to try the latest doxygen version, and even possibly
> the git master branch ? Scoped nums still have at least one problem
> (https://github.com/doxygen/doxygen/issues/6471, I need to follow up on
> that), maybe you're hitting the same bug.
>
> > On Wed, 19 Aug 2020 at 18:48, David Plowman wrote:
> > >
> > > Ah yes, thanks, just needed to install doxygen!
> > >
> > > On Wed, 19 Aug 2020 at 18:38, Laurent Pinchart wrote:
> > > > On Wed, Aug 19, 2020 at 06:10:17PM +0100, David Plowman wrote:
> > > > > Hi everyone
> > > > >
> > > > > Please excuse the dumb question, but I'm wanting to write some
> > > > > documentation (for Transforms). How do I compile and check what I've
> > > > > written - perhaps I have missed something?
> > > >
> > > > Make sure that the documentation option isn't disabled (you can check
> > > > with 'meson configure'), and that doxygen is installed. The
> > > > documentation should then be compiled when you run ninja.
>
> --
> Regards,
>
> Laurent Pinchart