Boost logo

Boost :

Subject: Do we need doxygen file header?
From: Mateusz Loskot (mateusz_at_[hidden])
Date: 2018-09-27 18:49:37


Guys,

Do we really need this?

////////////////////////////////////////////////////////////////////////////////////////
/// \file
/// \brief A model of a heterogeneous pixel that is not byte aligned.
Examples are bitmap (1-bit pixels) or 6-bit RGB (222)
/// \author Lubomir Bourdev and Hailin Jin \n
/// Adobe Systems Incorporated
/// \date 2005-2007 \n Last updated on September 28, 2006
///
////////////////////////////////////////////////////////////////////////////////////////

If we want to keep per-file description for Doxygen [1]
perhaps we could simplify it to

/// \file
/// \brief ...

and stick below the licence notice.

Comments?

[1] http://boostorg.github.io/gil/develop/doc/html/reference/files.html

Best regards,

-- 
Mateusz Loskot, http://mateusz.loskot.net

Boost list run by Boost-Gil-Owners