@section command is not working properly in doxygen comments
toomyem opened this issue · comments
Most of *.h files begins with license which looks similar to this example taken from assert.h:
/**
* @section License
*
* The MIT License (MIT)
(...)
#ifndef __KERNEL_ASSERT_H__
#define __KERNEL_ASSERT_H__
/**
* Make an assert fatal by negating the error code.
*/
#define FATAL(n) (-n)
Unfortunately doxygen somehow wrongly parses this and as a result we have license text combined with the description of the first item in the code. In the example above it is FATAL macro definition.
As a result on documentation pages all first items are not described - the combined license and item's description is not displayed at all.
How about using this comment instead, to make Doxygen ignore it? It solves the problem with the missing description of the first definition in the file. Is there a better way?
/*
* The MIT License (MIT)
*
...
*
* This file is part of the Simba project.
*/+1 for this solution.
Fixed in cd26e98.