Skip to content

Commit 830ba53

Browse files
couetcouet
authored
Better TOCs at the beginning of classes headers (#7951)
Reactivate the doxygen TOC for \page
1 parent 74f7b89 commit 830ba53

File tree

21 files changed

+612
-414
lines changed

21 files changed

+612
-414
lines changed

‎core/base/src/TAttFill.cxx‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,11 @@ attributes.
3232
## Fill Area attributes
3333
Fill Area attributes are:
3434
35-
- [Fill Area color](#F1)</a>
36-
- [Fill Area style](#F2)</a>
35+
- [Fill Area color](\ref F1)
36+
- [Fill Area style](\ref F2)
3737
38-
## <a name="F1"></a> Fill Area color
38+
\anchor F1
39+
## Fill Area color
3940
The fill area color is a color index (integer) pointing in the ROOT
4041
color table.
4142
The fill area color of any class inheriting from `TAttFill` can
@@ -103,7 +104,8 @@ If the current style fill area color is set to 0, then ROOT will force
103104
a black&white output for all objects with a fill area defined and independently
104105
of the object fill style.
105106
106-
## <a name="F2"></a> Fill Area style
107+
\anchor F2
108+
## Fill Area style
107109
The fill area style defines the pattern used to fill a polygon.
108110
The fill area style of any class inheriting from `TAttFill` can
109111
be changed using the method `SetFillStyle` and retrieved using the

‎core/base/src/TAttLine.cxx‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,12 @@ by many other classes (graphics, histograms). It holds all the line attributes.
3333
## Line attributes
3434
Line attributes are:
3535
36-
- [Line Color](#L1)
37-
- [Line Width](#L2)
38-
- [Line Style](#L3)
36+
- [Line Color](\ref L1)
37+
- [Line Width](\ref L2)
38+
- [Line Style](\ref L3)
3939
40-
## <a name="L1"></a> Line Color
40+
\anchor L1
41+
## Line Color
4142
The line color is a color index (integer) pointing in the ROOT
4243
color table.
4344
The line color of any class inheriting from `TAttLine` can
@@ -68,7 +69,8 @@ in `$ROOTSYS/etc/system.rootrc`, or on Mac with the Cocoa backend. On the file o
6869
it is visible with PDF, PNG, Gif, JPEG, SVG, TeX ... but not PostScript.
6970
7071
71-
## <a name="L2"></a> Line Width
72+
\anchor L2
73+
## Line Width
7274
The line width is expressed in pixel units.
7375
The line width of any class inheriting from `TAttLine` can
7476
be changed using the method `SetLineWidth` and retrieved using the
@@ -91,7 +93,8 @@ Begin_Macro
9193
}
9294
End_Macro
9395
94-
## <a name="L3"></a> Line Style
96+
\anchor L3
97+
## Line Style
9598
Line styles are identified via integer numbers. The line style of any class
9699
inheriting from `TAttLine` can be changed using the method
97100
`SetLineStyle` and retrieved using the method `GetLineStyle`.

‎core/base/src/TAttMarker.cxx‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,13 @@ attributes.
3333
## Marker attributes
3434
The marker attributes are:
3535
36-
- [Marker color](#M1)
37-
- [Marker style](#M2)
38-
- [Marker line width](#M21)
39-
- [Marker size](#M3)
36+
- [Marker color](\ref M1)
37+
- [Marker style](\ref M2)
38+
- [Marker line width](\ref M21)
39+
- [Marker size](\ref M3)
4040
41-
## <a name="M1"></a> Marker color
41+
\anchor M1
42+
## Marker color
4243
The marker color is a color index (integer) pointing in the ROOT color
4344
table.
4445
The marker color of any class inheriting from `TAttMarker` can
@@ -69,7 +70,8 @@ The transparency is available on all platforms when the flag `OpenGL.CanvasPrefe
6970
in `$ROOTSYS/etc/system.rootrc`, or on Mac with the Cocoa backend. On the file output
7071
it is visible with PDF, PNG, Gif, JPEG, SVG, TeX ... but not PostScript.
7172
72-
## <a name="M2"></a> Marker style
73+
\anchor M2
74+
## Marker style
7375
7476
The Marker style defines the markers' shape.
7577
The marker style of any class inheriting from `TAttMarker` can
@@ -132,7 +134,8 @@ Begin_Macro
132134
}
133135
End_Macro
134136
135-
### <a name="M21"></a> Marker line width
137+
\anchor M21
138+
### Marker line width
136139
137140
The line width of a marker is not actually a marker attribute since it does
138141
only apply to open marker symbols and marker symbols consisting of lines. All
@@ -156,7 +159,8 @@ Begin_Macro
156159
}
157160
End_Macro
158161
159-
## <a name="M3"></a> Marker size
162+
\anchor M3
163+
## Marker size
160164
161165
Various marker sizes are shown in the figure below. The default marker size=1
162166
is shown in the top left corner. Marker sizes smaller than 1 can be

‎core/base/src/TAttText.cxx‎

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,17 @@ by many other classes (graphics, histograms). It holds all the text attributes.
3434
## Text attributes
3535
Text attributes are:
3636
37-
- [Text Alignment](#T1)
38-
- [Text Angle](#T2)
39-
- [Text Color](#T3)
40-
- [Text Size](#T4)
41-
- [Text Font and Precision](#T5)
42-
- [Font quality and speed](#T51)
43-
- [How to use True Type Fonts](#T52)
44-
- [List of the currently supported fonts](#T53)
45-
46-
## <a name="T1"></a> Text Alignment
37+
- [Text Alignment](\ref T1)
38+
- [Text Angle](\ref T2)
39+
- [Text Color](\ref T3)
40+
- [Text Size](\ref T4)
41+
- [Text Font and Precision](\ref T5)
42+
- [Font quality and speed](\ref T51)
43+
- [How to use True Type Fonts](\ref T52)
44+
- [List of the currently supported fonts](\ref T53)
45+
46+
\anchor T1
47+
## Text Alignment
4748
4849
The text alignment is an integer number (`align`) allowing to control
4950
the horizontal and vertical position of the text string with respect
@@ -92,7 +93,8 @@ They allow to write:
9293
object->SetTextAlign(kHAlignLeft+kVAlignTop);
9394
~~~
9495
95-
## <a name="T2"></a> Text Angle
96+
\anchor T2
97+
## Text Angle
9698
9799
Text angle in degrees.
98100
The text angle of any class inheriting from `TAttText` can
@@ -104,7 +106,8 @@ Begin_Macro(source)
104106
textangle.C
105107
End_Macro
106108
107-
## <a name="T3"></a> Text Color
109+
\anchor T3
110+
## Text Color
108111
109112
The text color is a color index (integer) pointing in the ROOT
110113
color table.
@@ -135,7 +138,8 @@ The transparency is available on all platforms when the flag `OpenGL.CanvasPrefe
135138
in `$ROOTSYS/etc/system.rootrc`, or on Mac with the Cocoa backend. On the file output
136139
it is visible with PDF, PNG, Gif, JPEG, SVG, TeX ... but not PostScript.
137140
138-
## <a name="T4"></a> Text Size
141+
\anchor T4
142+
## Text Size
139143
140144
If the text precision (see next paragraph) is smaller than 3, the text
141145
size (`textsize`) is a fraction of the current pad size. Therefore the
@@ -165,7 +169,8 @@ The text size of any class inheriting from `TAttText` can
165169
be changed using the method `SetTextSize` and retrieved using the
166170
method `GetTextSize`.
167171
168-
## <a name="T5"></a> Text Font and Precision
172+
\anchor T5
173+
## Text Font and Precision
169174
170175
The text font code is combination of the font number and the precision.
171176
~~~ {.cpp}
@@ -185,7 +190,8 @@ The text font and precision of any class inheriting from `TAttText` can
185190
be changed using the method `SetTextFont` and retrieved using the
186191
method `GetTextFont`.
187192
188-
### <a name="T51"></a> Font quality and speed
193+
\anchor T51
194+
### Font quality and speed
189195
190196
When precision 0 is used, only the original non-scaled system fonts are
191197
used. The fonts have a minimum (4) and maximum (37) size in pixels. These
@@ -195,7 +201,8 @@ Precision 1 and 2 fonts have a different behaviour depending if the
195201
True Type Fonts (TTF) are used or not. If TTF are used, you always get very good
196202
quality scalable and rotatable fonts. However TTF are slow.
197203
198-
### <a name="T52"></a> How to use True Type Fonts
204+
\anchor T52
205+
### How to use True Type Fonts
199206
200207
One can activate the TTF by adding (or activating) the following line
201208
in the `.rootrc` file:
@@ -218,7 +225,8 @@ printout given by this command:
218225
Unix.*.Root.UseTTFonts: true [Global]
219226
~~~
220227
221-
### <a name="T53"></a> List of the currently supported fonts
228+
\anchor T53
229+
### List of the currently supported fonts
222230
223231
~~~ {.cpp}
224232
Font number X11 Names Win32/TTF Names

‎core/base/src/TColor.cxx‎

Lines changed: 28 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -57,17 +57,18 @@ using std::floor;
5757
5858
The color creation and management class.
5959
60-
- [Introduction](#C00)
61-
- [Basic colors](#C01)
62-
- [The color wheel](#C02)
63-
- [Bright and dark colors](#C03)
64-
- [Gray scale view of of canvas with colors](#C04)
65-
- [Color palettes](#C05)
66-
- [High quality predefined palettes](#C06)
67-
- [Palette inversion](#C061)
68-
- [Color transparency](#C07)
69-
70-
## <a name="C00"></a> Introduction
60+
- [Introduction](\ref C00)
61+
- [Basic colors](\ref C01)
62+
- [The color wheel](\ref C02)
63+
- [Bright and dark colors](\ref C03)
64+
- [Gray scale view of of canvas with colors](\ref C04)
65+
- [Color palettes](\ref C05)
66+
- [High quality predefined palettes](\ref C06)
67+
- [Palette inversion](\ref C061)
68+
- [Color transparency](\ref C07)
69+
70+
\anchor C00
71+
## Introduction
7172
7273
Colors are defined by their red, green and blue components, simply called the
7374
RGB components. The colors are also known by the hue, light and saturation
@@ -108,7 +109,8 @@ Two sets of colors are initialized;
108109
- The basic colors: colors with index from 0 to 50.
109110
- The color wheel: colors with indices from 300 to 1000.
110111
111-
## <a name="C01"></a> Basic colors
112+
\anchor C01
113+
## Basic colors
112114
The following image displays the 50 basic colors.
113115
114116
Begin_Macro(source)
@@ -119,7 +121,8 @@ Begin_Macro(source)
119121
}
120122
End_Macro
121123
122-
## <a name="C02"></a> The color wheel
124+
\anchor C02
125+
## The color wheel
123126
The wheel contains the recommended 216 colors to be used in web applications.
124127
125128
The colors in the color wheel are created by `TColor::CreateColorWheel`.
@@ -172,7 +175,8 @@ simplest is to define an other white color not attached to the color index 0:
172175
TColor *color = new TColor(ci, 1., 1., 1.);
173176
~~~
174177
175-
## <a name="C03"></a> Bright and dark colors
178+
\anchor C03
179+
## Bright and dark colors
176180
The dark and bright color are used to give 3-D effects when drawing various
177181
boxes (see TWbox, TPave, TPaveText, TPaveLabel, etc).
178182
@@ -186,7 +190,8 @@ boxes (see TWbox, TPave, TPaveText, TPaveLabel, etc).
186190
Int_t bright = TColor::GetColorBright(color_index);
187191
~~~
188192
189-
## <a name="C04"></a> Grayscale view of of canvas with colors
193+
\anchor C04
194+
## Grayscale view of of canvas with colors
190195
One can toggle between a grayscale preview and the regular colored mode using
191196
`TCanvas::SetGrayscale()`. Note that in grayscale mode, access via RGB
192197
will return grayscale values according to ITU standards (and close to b&w
@@ -203,7 +208,8 @@ Begin_Macro(source)
203208
}
204209
End_Macro
205210
206-
## <a name="C05"></a> Color palettes
211+
\anchor C05
212+
## Color palettes
207213
It is often very useful to represent a variable with a color map. The concept
208214
of "color palette" allows to do that. One color palette is active at any time.
209215
This "current palette" is set using:
@@ -287,7 +293,8 @@ Begin_Macro(source)
287293
../../../tutorials/graphs/multipalette.C
288294
End_Macro
289295
290-
## <a name="C06"></a> High quality predefined palettes
296+
\anchor C06
297+
## High quality predefined palettes
291298
\since **6.04:**
292299
62 high quality palettes are predefined with 255 colors each.
293300
Despite the [disadvantages of the Rainbow color map](https://root.cern.ch/rainbow-color-map),
@@ -910,7 +917,8 @@ End_Macro
910917
</td></tr>
911918
</table>
912919
913-
## <a name="C061"></a> Palette inversion
920+
\anchor C061
921+
## Palette inversion
914922
Once a palette is defined, it is possible to invert the color order thanks to the
915923
method TColor::InvertPalette. The top of the palette becomes the bottom and vice versa.
916924
@@ -924,7 +932,8 @@ Begin_Macro(source)
924932
}
925933
End_Macro
926934
927-
## <a name="C07"></a> Color transparency
935+
\anchor C07
936+
## Color transparency
928937
To make a graphics object transparent it is enough to set its color to a
929938
transparent one. The color transparency is defined via its alpha component. The
930939
alpha value varies from `0.` (fully transparent) to `1.` (fully

‎documentation/doxygen/Doxyfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ MARKDOWN_SUPPORT = YES
313313
# Minimum value: 0, maximum value: 99, default value: 0.
314314
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
315315

316-
TOC_INCLUDE_HEADINGS = 0
316+
TOC_INCLUDE_HEADINGS = 3
317317

318318
# When enabled doxygen tries to link words that correspond to documented
319319
# classes, or namespaces to their corresponding documentation. Such a link can

0 commit comments

Comments
 (0)