Re: RFC: license headers interfere with doxygen documentation (MESOS-3581)

Hi, thanks everyone for providing suggestions and feedback. It seems we reached a consensus to implement option (a): > (a) change *all* license headers to be wrapped in e.g. `/* .. */`, also > update the coding guidelines, or and to keep improving the documentation in the code to provide

Re: RFC: license headers interfere with doxygen documentation (MESOS-3581)

Please be aware that doxygen renders html differently than the middleman (templating engine that we use on mesos.apache.org). So before pushing changes please verify everything locally (https://github.com/apache/mesos/tree/master/support/site-docker. Cheers, Artem. On Wed, Oct 21, 2015 at 1:56

Re: RFC: license headers interfere with doxygen documentation (MESOS-3581)

Excellent idea! Let’s call this c) It’s more work than a), but has to be done eventually anyway. > On Oct 20, 2015, at 11:49 PM, Joseph Wu wrote: > > +/- 0 (a) wouldn't hurt, but isn't the best solution. > > > I'd vote for adding actual comment blocks to each class.

Re: RFC: license headers interfere with doxygen documentation (MESOS-3581)

Hi Joseph, yes, doing the right thing and having everything documented would make most of this cleaner. There is still an issue with e.g. namespaces (or anything else the particular language allows to be extended later on): {foo.hpp} /** Licensed .. */ /** Foo is

Re: RFC: license headers interfere with doxygen documentation (MESOS-3581)

If this means that c) requires a), then we should do a) first, and then c) incrementally. > On Oct 21, 2015, at 10:23 AM, Benjamin Bannier > wrote: > > Hi Joseph, > > yes, doing the right thing and having everything documented would make most > of this

Re: RFC: license headers interfere with doxygen documentation (MESOS-3581)

+1 for (a), in this case the wide sweep only touches the license comments, so it won't be disruptive to history. On Tue, Oct 20, 2015 at 11:59 AM, James Peach wrote: > > > On Oct 20, 2015, at 8:55 AM, Bernd Mathiske wrote: > > > > All, is changing every

Re: RFC: license headers interfere with doxygen documentation (MESOS-3581)

+1 for (a). — *Joris Van Remoortere* Mesosphere On Tue, Oct 20, 2015 at 3:02 PM, Benjamin Mahler wrote: > +1 for (a), in this case the wide sweep only touches the license comments, > so it won't be disruptive to history. > > On Tue, Oct 20, 2015 at 11:59 AM, James

Re: RFC: license headers interfere with doxygen documentation (MESOS-3581)

> On Oct 20, 2015, at 8:55 AM, Bernd Mathiske wrote: > > All, is changing every source code file prohibitive or not? > >> On Oct 20, 2015, at 10:01 AM, Benjamin Bannier >> wrote: >> >> Hi, >> >> I would like to ask for input on how we

Re: RFC: license headers interfere with doxygen documentation (MESOS-3581)

All, is changing every source code file prohibitive or not? > On Oct 20, 2015, at 10:01 AM, Benjamin Bannier > wrote: > > Hi, > > I would like to ask for input on how we plan to fix (both short- and > longterm) the interference of the license headers and

Re: RFC: license headers interfere with doxygen documentation (MESOS-3581)

+1 (and thanks for flagging this!) -- *Marco Massenzio* Distributed Systems Engineer http://codetrips.com On Tue, Oct 20, 2015 at 12:14 PM, Joris Van Remoortere wrote: > +1 for (a). > > > — > *Joris Van Remoortere* > Mesosphere > > On Tue, Oct 20, 2015 at 3:02 PM, Benjamin

Re: RFC: license headers interfere with doxygen documentation (MESOS-3581)

+/- 0 (a) wouldn't hurt, but isn't the best solution. I'd vote for adding actual comment blocks to each class. Doxygen takes the comment block immediately preceding the class and uses that as the description. This means a file like this would show up correctly on Doxygen: /** * License ...