Skip to content
This repository was archived by the owner on Mar 22, 2023. It is now read-only.

Commit e8f5621

Browse files
igchorigchor
authored
Merge pull request #1177 from karczex/update-doxygen-config
Update doxygen config
2 parents 14677b5 + c231064 commit e8f5621

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+3146
-197
lines changed

‎.github/workflows/gha.yml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ env:
1414
GITHUB_REPO: pmem/libpmemobj-cpp
1515
CONTAINER_REG: ghcr.io/pmem/libpmemobj-cpp
1616
HOST_WORKDIR: ${{ github.workspace }}
17-
TEST_TIMEOUT: 600
17+
TEST_TIMEOUT: 800
1818
IMG_VER: latest
1919

2020
jobs:
@@ -30,6 +30,7 @@ jobs:
3030
strategy:
3131
matrix:
3232
CONFIG: ["TYPE=debug OS=fedora OS_VER=32 PUSH_IMAGE=1",
33+
"TYPE=debug OS=fedora OS_VER=34 PUSH_IMAGE=1",
3334
"TYPE=debug OS=ubuntu OS_VER=20.04 PUSH_IMAGE=1 CHECK_CPP_STYLE=1",
3435
"TYPE=debug OS=ubuntu OS_VER=20.04 COVERAGE=1",
3536
"TYPE=release OS=fedora OS_VER=32",
@@ -80,7 +81,7 @@ jobs:
8081
github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/stable-')
8182
strategy:
8283
matrix:
83-
CONFIG: ["TYPE=doc OS=fedora OS_VER=32"]
84+
CONFIG: ["TYPE=doc OS=fedora OS_VER=34"]
8485
steps:
8586
- name: Clone the git repo
8687
uses: actions/checkout@v2

‎CONTRIBUTING.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,12 @@ make cppformat
3333

3434
**NOTE**: We're using specific clang-format - version exactly **9.0** is required.
3535

36+
## Doxygen documentation
37+
38+
* Each new feature should be documented using doxygen comment blocks.
39+
* Each non-member function should be added to corresponding class documentation by `@relates` tag
40+
* Each new API should be assigned to group by `@ingroup` tag. See [groups definitions file](doc/groups_definitions.dox) in the repository for details.
41+
3642
# Submitting Pull Requests
3743

3844
We take outside code contributions to `libpmemobj-cpp` through GitHub pull requests.

‎doc/DoxygenLayout.xml‎

Lines changed: 226 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,226 @@
1+
<doxygenlayout version="1.0">
2+
<!-- Generated by doxygen 1.9.1 -->
3+
<!-- Navigation index tabs for HTML output -->
4+
<navindex>
5+
<tab type="mainpage" visible="yes" title=""/>
6+
<tab type="pages" visible="yes" title="" intro=""/>
7+
<tab type="modules" visible="yes" title="Features" intro="Groups of libpmemobj-cpp features:"/>
8+
<tab type="namespaces" visible="yes" title="">
9+
<tab type="namespacelist" visible="yes" title="" intro=""/>
10+
<tab type="namespacemembers" visible="yes" title="" intro=""/>
11+
</tab>
12+
<tab type="interfaces" visible="yes" title="">
13+
<tab type="interfacelist" visible="yes" title="" intro=""/>
14+
<tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
15+
<tab type="interfacehierarchy" visible="yes" title="" intro=""/>
16+
</tab>
17+
<tab type="classes" visible="yes" title="">
18+
<tab type="classlist" visible="yes" title="" intro=""/>
19+
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
20+
<tab type="hierarchy" visible="yes" title="" intro=""/>
21+
<tab type="classmembers" visible="yes" title="" intro=""/>
22+
</tab>
23+
<tab type="structs" visible="yes" title="">
24+
<tab type="structlist" visible="yes" title="" intro=""/>
25+
<tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
26+
</tab>
27+
<tab type="exceptions" visible="yes" title="">
28+
<tab type="exceptionlist" visible="yes" title="" intro=""/>
29+
<tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
30+
<tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
31+
</tab>
32+
<tab type="files" visible="yes" title="">
33+
<tab type="filelist" visible="yes" title="" intro=""/>
34+
<tab type="globals" visible="yes" title="" intro=""/>
35+
</tab>
36+
<tab type="examples" visible="yes" title="" intro=""/>
37+
</navindex>
38+
39+
<!-- Layout definition for a class page -->
40+
<class>
41+
<briefdescription visible="yes"/>
42+
<includes visible="$SHOW_INCLUDE_FILES"/>
43+
<inheritancegraph visible="$CLASS_GRAPH"/>
44+
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
45+
<memberdecl>
46+
<nestedclasses visible="yes" title=""/>
47+
<publictypes title=""/>
48+
<services title=""/>
49+
<interfaces title=""/>
50+
<publicslots title=""/>
51+
<signals title=""/>
52+
<publicmethods title=""/>
53+
<publicstaticmethods title=""/>
54+
<publicattributes title=""/>
55+
<publicstaticattributes title=""/>
56+
<protectedtypes title=""/>
57+
<protectedslots title=""/>
58+
<protectedmethods title=""/>
59+
<protectedstaticmethods title=""/>
60+
<protectedattributes title=""/>
61+
<protectedstaticattributes title=""/>
62+
<packagetypes title=""/>
63+
<packagemethods title=""/>
64+
<packagestaticmethods title=""/>
65+
<packageattributes title=""/>
66+
<packagestaticattributes title=""/>
67+
<properties title=""/>
68+
<events title=""/>
69+
<privatetypes title=""/>
70+
<privateslots title=""/>
71+
<privatemethods title=""/>
72+
<privatestaticmethods title=""/>
73+
<privateattributes title=""/>
74+
<privatestaticattributes title=""/>
75+
<friends title=""/>
76+
<related title="" subtitle=""/>
77+
<membergroups visible="yes"/>
78+
</memberdecl>
79+
<detaileddescription title=""/>
80+
<memberdef>
81+
<inlineclasses title=""/>
82+
<typedefs title=""/>
83+
<enums title=""/>
84+
<services title=""/>
85+
<interfaces title=""/>
86+
<constructors title=""/>
87+
<functions title=""/>
88+
<related title=""/>
89+
<variables title=""/>
90+
<properties title=""/>
91+
<events title=""/>
92+
</memberdef>
93+
<allmemberslink visible="yes"/>
94+
<usedfiles visible="$SHOW_USED_FILES"/>
95+
<authorsection visible="yes"/>
96+
</class>
97+
98+
<!-- Layout definition for a namespace page -->
99+
<namespace>
100+
<briefdescription visible="yes"/>
101+
<memberdecl>
102+
<nestednamespaces visible="yes" title=""/>
103+
<constantgroups visible="yes" title=""/>
104+
<interfaces visible="yes" title=""/>
105+
<classes visible="yes" title=""/>
106+
<structs visible="yes" title=""/>
107+
<exceptions visible="yes" title=""/>
108+
<typedefs title=""/>
109+
<sequences title=""/>
110+
<dictionaries title=""/>
111+
<enums title=""/>
112+
<functions title=""/>
113+
<variables title=""/>
114+
<membergroups visible="yes"/>
115+
</memberdecl>
116+
<detaileddescription title=""/>
117+
<memberdef>
118+
<inlineclasses title=""/>
119+
<typedefs title=""/>
120+
<sequences title=""/>
121+
<dictionaries title=""/>
122+
<enums title=""/>
123+
<functions title=""/>
124+
<variables title=""/>
125+
</memberdef>
126+
<authorsection visible="yes"/>
127+
</namespace>
128+
129+
<!-- Layout definition for a file page -->
130+
<file>
131+
<briefdescription visible="yes"/>
132+
<includes visible="$SHOW_INCLUDE_FILES"/>
133+
<includegraph visible="$INCLUDE_GRAPH"/>
134+
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
135+
<sourcelink visible="yes"/>
136+
<memberdecl>
137+
<interfaces visible="yes" title=""/>
138+
<classes visible="yes" title=""/>
139+
<structs visible="yes" title=""/>
140+
<exceptions visible="yes" title=""/>
141+
<namespaces visible="yes" title=""/>
142+
<constantgroups visible="yes" title=""/>
143+
<defines title=""/>
144+
<typedefs title=""/>
145+
<sequences title=""/>
146+
<dictionaries title=""/>
147+
<enums title=""/>
148+
<functions title=""/>
149+
<variables title=""/>
150+
<membergroups visible="yes"/>
151+
</memberdecl>
152+
<detaileddescription title=""/>
153+
<memberdef>
154+
<inlineclasses title=""/>
155+
<defines title=""/>
156+
<typedefs title=""/>
157+
<sequences title=""/>
158+
<dictionaries title=""/>
159+
<enums title=""/>
160+
<functions title=""/>
161+
<variables title=""/>
162+
</memberdef>
163+
<authorsection/>
164+
</file>
165+
166+
<!-- Layout definition for a group page -->
167+
<group>
168+
<briefdescription visible="yes"/>
169+
<groupgraph visible="$GROUP_GRAPHS"/>
170+
<memberdecl>
171+
<nestedgroups visible="yes" title=""/>
172+
<dirs visible="yes" title=""/>
173+
<files visible="yes" title=""/>
174+
<namespaces visible="yes" title=""/>
175+
<classes visible="yes" title=""/>
176+
<defines title=""/>
177+
<typedefs title=""/>
178+
<sequences title=""/>
179+
<dictionaries title=""/>
180+
<enums title=""/>
181+
<enumvalues title=""/>
182+
<functions title=""/>
183+
<variables title=""/>
184+
<signals title=""/>
185+
<publicslots title=""/>
186+
<protectedslots title=""/>
187+
<privateslots title=""/>
188+
<events title=""/>
189+
<properties title=""/>
190+
<friends title=""/>
191+
<membergroups visible="yes"/>
192+
</memberdecl>
193+
<detaileddescription title=""/>
194+
<memberdef>
195+
<pagedocs/>
196+
<inlineclasses title=""/>
197+
<defines title=""/>
198+
<typedefs title=""/>
199+
<sequences title=""/>
200+
<dictionaries title=""/>
201+
<enums title=""/>
202+
<enumvalues title=""/>
203+
<functions title=""/>
204+
<variables title=""/>
205+
<signals title=""/>
206+
<publicslots title=""/>
207+
<protectedslots title=""/>
208+
<privateslots title=""/>
209+
<events title=""/>
210+
<properties title=""/>
211+
<friends title=""/>
212+
</memberdef>
213+
<authorsection visible="yes"/>
214+
</group>
215+
216+
<!-- Layout definition for a directory page -->
217+
<directory>
218+
<briefdescription visible="yes"/>
219+
<directorygraph visible="yes"/>
220+
<memberdecl>
221+
<dirs visible="yes"/>
222+
<files visible="yes"/>
223+
</memberdecl>
224+
<detaileddescription title=""/>
225+
</directory>
226+
</doxygenlayout>

‎doc/groups_definitions.dox‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# SPDX-License-Identifier: BSD-3-Clause
2+
# Copyright 2021, Intel Corporation
3+
4+
/** @defgroup containers Containers*/
5+
/** @defgroup experimental_containers Experimental Containers */
6+
/** @defgroup transactions Transactions*/
7+
/** @defgroup allocation Allocation*/
8+
/** @defgroup data_view Data View*/
9+
/** @defgroup synchronization Synchronization Primitives*/
10+
/** @defgroup primitives Primitives*/
11+
/** @defgroup exceptions Exceptions*/

0 commit comments

Comments
 (0)