diff options
author | Sarah Sharp <[email protected]> | 2015-10-29 12:12:40 -0700 |
---|---|---|
committer | Sarah Sharp <[email protected]> | 2016-03-14 14:00:29 -0700 |
commit | 0f5bfc7f016d05240a9cd0a46226f6895569ab3e (patch) | |
tree | 76236a2ac33fb9587ff47ca30916a61bb13eb317 /install-gallium-links.mk | |
parent | e9d68cc3da07c4b566799bbaec2434bfc21d3e0c (diff) |
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 <[email protected]>
Diffstat (limited to 'install-gallium-links.mk')
0 files changed, 0 insertions, 0 deletions