mesa: docs: i965: Use correct doxygen groupings syntax

When reading the source code, it's useful to indicate that a group of
fields in a struct are related in someway. There were several places
where people tried to group related structure members with the {@
syntax, without realizing they also needed to add the \name syntax in
order to generate correct doxygen html.

There are several files with groupings that look like this:

struct foo {
    /**
     * Related fields description
     * @{
     */
    int bar;
    char baz;
    /** @} */
    long qux;
}

However, the doxygen syntax for grouping is:

struct foo {
    /**
     * \name Related fields description
     * @{
     */
    int bar;
    char baz;
    /** @} */
    long qux;
}

https://www.stack.nl/~dimitri/doxygen/manual/grouping.html

Without the group name definition, the fields don't get properly
grouped. Instead, the group description is applied to the first field.

Fix the Intel hardware information structure, brw_device_info to
properly group the GPU hardware limitations and hardware quirks fields.

Once you've run `cd doxygen; make clean; make all`,
updated documentation can be found at

mesa/doxygen/i965/structbrw__device__info.html

Signed-off-by: Sarah Sharp <sarah.a.sharp@linux.intel.com>
This commit is contained in:
Sarah Sharp 2015-10-29 12:12:40 -07:00
parent e9d68cc3da
commit 0f5bfc7f01

View file

@ -49,7 +49,7 @@ struct brw_device_info
bool has_resource_streamer;
/**
* Quirks:
* \name Intel hardware quirks
* @{
*/
bool has_negative_rhw_bug;
@ -65,7 +65,7 @@ struct brw_device_info
/** @} */
/**
* GPU Limits:
* \name GPU hardware limits
* @{
*/
/**