summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSarah Sharp <[email protected]>2015-10-29 12:12:40 -0700
committerSarah Sharp <[email protected]>2016-03-14 14:00:29 -0700
commit0f5bfc7f016d05240a9cd0a46226f6895569ab3e (patch)
tree76236a2ac33fb9587ff47ca30916a61bb13eb317
parente9d68cc3da07c4b566799bbaec2434bfc21d3e0c (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]>
-rw-r--r--src/mesa/drivers/dri/i965/brw_device_info.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/mesa/drivers/dri/i965/brw_device_info.h b/src/mesa/drivers/dri/i965/brw_device_info.h
index 5c9517eda0f..af2e459fe48 100644
--- a/src/mesa/drivers/dri/i965/brw_device_info.h
+++ b/src/mesa/drivers/dri/i965/brw_device_info.h
@@ -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
* @{
*/
/**