Skip to content

Commit 51eb78b

Browse files
author
p12
committed
Index: move the documentation to a separate file
1 parent 37f9438 commit 51eb78b

File tree

2 files changed

+85
-83
lines changed

2 files changed

+85
-83
lines changed

index-functions.README

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
This file defines the schema of the index-functions-*.xml files.
2+
3+
/index/const defines a macro/constant/enum value
4+
/index/function defines a global function
5+
/index/class defines a class
6+
/index/enum defines an enum
7+
8+
"name" attribute: name of the identifier (with the namespace prefix)
9+
"link" attribute: link relative to the wiki root
10+
"since" attribute: (optional) "c++11" or none
11+
12+
//class/const defines a macro/member constant/member enum value
13+
//enum/const defines an enum class value (only in c++11)
14+
//class/function defines a member function
15+
//class/class defines a member class
16+
//class/enum defines a member enum
17+
18+
"name" attribute: name of the function/class (without the parent class/namespace prefix)
19+
"link" attribute: (optional) link relative to the parent class
20+
by default equals to 'name'
21+
if set to "." the resulting link targets to the page of the parent class
22+
23+
"since" attribute: (optional) "c++11" or none
24+
25+
//class/overload
26+
27+
defines a function overload or function specialization of some function
28+
accepts the class as one of the arguments and can be found using ADL.
29+
30+
"name" attribute: name of the identifier (with the namespace prefix)
31+
"link" attribute: link relative to the parent class
32+
if set to "." the resulting link targets to the page of the parent class
33+
"since" attribute: (optional) "c++11" or none
34+
35+
//class/specialization
36+
defines a specialization of an unrelated class for specific type (for
37+
function specializations use 'overload')
38+
39+
"name" attribute: name of the identifier (with the namespace prefix)
40+
"link" attribute: link relative to the parent class
41+
if set to "." the resulting link targets to the page of the parent class
42+
"since" attribute: (optional) "c++11" or none
43+
44+
//class/constructor
45+
46+
defines a constructor. Equivalent to <function name="@@@"/> where @@@ is the name of the
47+
parent class without the namespace prefix
48+
49+
//class/destructor
50+
51+
defines a destructor. Equivalent to <function name="~@@@"/> where @@@ is the name of the
52+
parent class without the namespace prefix
53+
54+
/index/typedef defines a typedef
55+
56+
"name" attribute: name of the identifier (with the namespace prefix)
57+
"link" attribute: link relative to the wiki root
58+
"alias" attribute: name of the identifier whose contents to import.
59+
Allowed identifiers: '/index/class' and '/index/enum'
60+
"since" attribute: (optional) "c++11" or none
61+
"alias" and "link" attributes are incompatible
62+
63+
//class/typedef defines a member typedef
64+
65+
"name" attribute: name of the identifier (with the namespace prefix)
66+
"link" attribute: link relative to the wiki root
67+
"alias" attribute: name of the identifier whose contents to import
68+
Allowed identifiers: '/index/class' and '/index/enum'
69+
"since" attribute: (optional) "c++11" or none
70+
"alias" and "link" attributes are incompatible
71+
72+
//class/inherits
73+
74+
imports all class and function members of another class.
75+
76+
"name" attribute: name of the identifier whose contents to import.
77+
Allowed identifiers: '/index/class' and '/index/enum'
78+
79+
80+
Note: replace spaces in all links with '_'
81+
Note: currently the alias attributes is not handled by the XSLT scripts
82+
Todo: add pseudo-random number generators and distributions
83+
Todo: add non-member functions, e.g. std::swap overloads

index-functions.xml

Lines changed: 2 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -19,89 +19,8 @@
1919
-->
2020

2121
<!--
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
10524
-->
10625
<index>
10726

0 commit comments

Comments
 (0)