|
19 | 19 | --> |
20 | 20 |
|
21 | 21 | <!-- |
22 | | - structure: |
23 | | -
|
24 | | - /index/const defines a macro/constant/enum value |
25 | | - /index/function defines a global function |
26 | | - /index/class defines a class |
27 | | - /index/enum defines an enum |
28 | | -
|
29 | | - "name" attribute: name of the identifier (with the namespace prefix) |
30 | | - "link" attribute: link relative to the wiki root |
31 | | - "since" attribute: (optional) "c++11" or none |
32 | | -
|
33 | | - //class/const defines a macro/member constant/member enum value |
34 | | - //enum/const defines an enum class value (only in c++11) |
35 | | - //class/function defines a member function |
36 | | - //class/class defines a member class |
37 | | - //class/enum defines a member enum |
38 | | - |
39 | | - "name" attribute: name of the function/class (without the parent class/namespace prefix) |
40 | | - "link" attribute: (optional) link relative to the parent class |
41 | | - by default equals to 'name' |
42 | | - if set to "." the resulting link targets to the page of the parent class |
43 | | -
|
44 | | - "since" attribute: (optional) "c++11" or none |
45 | | - |
46 | | - //class/overload |
47 | | - |
48 | | - defines a function overload or function specialization of some function |
49 | | - accepts the class as one of the arguments and can be found using ADL. |
50 | | - |
51 | | - "name" attribute: name of the identifier (with the namespace prefix) |
52 | | - "link" attribute: link relative to the parent class |
53 | | - if set to "." the resulting link targets to the page of the parent class |
54 | | - "since" attribute: (optional) "c++11" or none |
55 | | - |
56 | | - //class/specialization |
57 | | - defines a specialization of an unrelated class for specific type (for |
58 | | - function specializations use 'overload') |
59 | | - |
60 | | - "name" attribute: name of the identifier (with the namespace prefix) |
61 | | - "link" attribute: link relative to the parent class |
62 | | - if set to "." the resulting link targets to the page of the parent class |
63 | | - "since" attribute: (optional) "c++11" or none |
64 | | -
|
65 | | - //class/constructor |
66 | | -
|
67 | | - defines a constructor. Equivalent to <function name="@@@"/> where @@@ is the name of the |
68 | | - parent class without the namespace prefix |
69 | | -
|
70 | | - //class/destructor |
71 | | -
|
72 | | - defines a destructor. Equivalent to <function name="~@@@"/> where @@@ is the name of the |
73 | | - parent class without the namespace prefix |
74 | | -
|
75 | | - /index/typedef defines a typedef |
76 | | -
|
77 | | - "name" attribute: name of the identifier (with the namespace prefix) |
78 | | - "link" attribute: link relative to the wiki root |
79 | | - "alias" attribute: name of the identifier whose contents to import. |
80 | | - Allowed identifiers: '/index/class' and '/index/enum' |
81 | | - "since" attribute: (optional) "c++11" or none |
82 | | - "alias" and "link" attributes are incompatible |
83 | | - |
84 | | - //class/typedef defines a member typedef |
85 | | - |
86 | | - "name" attribute: name of the identifier (with the namespace prefix) |
87 | | - "link" attribute: link relative to the wiki root |
88 | | - "alias" attribute: name of the identifier whose contents to import |
89 | | - Allowed identifiers: '/index/class' and '/index/enum' |
90 | | - "since" attribute: (optional) "c++11" or none |
91 | | - "alias" and "link" attributes are incompatible |
92 | | -
|
93 | | - //class/inherits |
94 | | -
|
95 | | - imports all class and function members of another class. |
96 | | -
|
97 | | - "name" attribute: name of the identifier whose contents to import. |
98 | | - Allowed identifiers: '/index/class' and '/index/enum' |
99 | | -
|
100 | | -
|
101 | | - Note: replace spaces in all links with '_' |
102 | | - Note: currently the alias attributes is not handled by the XSLT scripts |
103 | | - Todo: add pseudo-random number generators and distributions |
104 | | - Todo: add non-member functions, e.g. std::swap overloads |
| 22 | + For the documentation of the schema, see the accompanying |
| 23 | + index-function.README file |
105 | 24 | --> |
106 | 25 | <index> |
107 | 26 |
|
|
0 commit comments