Re: Doxygen snapshot

[Libor Polčák]

> We just realised we sent this out without the relevant context (which was only 
> discussed in the call).
>
> But we'd like your feedback on what parts of the auto-generated documentation 
> are relevant, and which ones should be left out. The amount of docs generated 
> by Doxygen is pretty overwhelming, and we need help narrowing down what should 
> be presented to users + where we will be able to find it
>
> So if you could take the time to take a look and tell us which parts we should 
> focus on, we can then move forward in making a template to accomodate those 
> into the final website.
>
> Thanks, and have a great week!
> A&R
>
> On 1/29/21 4:05 PM, Ricardo Lafuente via Js-shield wrote:
> > It's online here:
> >
> > http://manufacturaindependente.org/js-shield-doxygen/ 
> > <http://manufacturaindependente.org/js-shield-doxygen/>

Hello Ricardo,

please can you regenerate from 
https://pagure.io/JS-Shield/JS-Shield/tree/doxygen? I added more content 
available as .md, the GPL text, CODING_STYLE.

We will ned to improve the formating, add more commands like 
https://www.doxygen.nl/manual/commands.html#cmdcopyright and 
https://www.doxygen.nl/manual/commands.html#cmdauthor, etc.

We will need to restructure the headers to something like:

/// \file This file ...
///
///  \author{Copyright (C) 2019  author1}
///  \author{Copyright (C) 2019  author2}
///
///  \copyright{GPL3+}
///
///  This program is free software: you can redistribute it and/or modify
///  it under the terms of the GNU General Public License as published by
///  the Free Software Foundation, either version 3 of the License, or
///  (at your option) any later version.
///
///  This program is distributed in the hope that it will be useful,
///  but WITHOUT ANY WARRANTY; without even the implied warranty of
///  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
///  GNU General Public License for more details.
///
///  You should have received a copy of the GNU General Public License
///  along with this program.  If not, see <https://www.gnu.org/licenses/>.
///

Thanks,

Libor