Skip to content

Commit

Permalink
Merge pull request #1710 from ericniebler/doxygen-with-concepts
Browse files Browse the repository at this point in the history 
touch up the docs, regen with doxygen 1.9.4
  • Loading branch information
@ericniebler
ericniebler committed Jun 21, 2022
2 parents dc83b9b + a6cc9f9 commit 003f42c
Show file tree
Hide file tree
Showing 241 changed files with 3,561 additions and 1,664 deletions.
4 changes: 2 additions & 2 deletions doc/CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#=============================================================================
if (NOT DOXYGEN_FOUND)
message(STATUS
"Doxygen not found; the 'doc' and 'gh-pages.{clean,copy,update}' targets "
"Doxygen not found; the 'range-v3-doc' and 'range-v3-gh-pages.{clean,copy,update}' targets "
"will be unavailable.")
return()
endif()
Expand Down Expand Up @@ -42,7 +42,7 @@ set_target_properties(range-v3-doc

if (NOT GIT_FOUND)
message(STATUS
"Git was not found; the 'gh-pages.{clean,copy,update}' targets "
"Git was not found; the 'range-v3-gh-pages.{clean,copy,update}' targets "
"will be unavailable.")
return()
endif()
Expand Down
2,912 changes: 2,738 additions & 174 deletions doc/Doxyfile.in
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion doc/gh-pages
Submodule gh-pages updated 7909 files
6 changes: 3 additions & 3 deletions doc/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -945,10 +945,10 @@ back to using `std::enable_if`.
--------------------------------------------------------------------------------
Range-v3 formed the basis for the
[Technical Specification on Ranges](https://www.iso.org/standard/70910.html),
which has since been merged into the working draft of C++20.
which has since been merged into the working draft and shipped with C++20 in
the `std::ranges` namespace.

In addition, a subset of range-v3's views are also a part of the C++20 working
draft, with more slated for eventual inclusion in future versions of C++.
More range adaptors are slated for inclusion in C++23 and beyond.

The actions, as well as various utilities, have not yet been reviewed by the
Committee, although the basic direction has already passed an initial review.
Expand Down
125 changes: 70 additions & 55 deletions doc/layout.xml
View file
Original file line number Diff line number Diff line change
@@ -1,67 +1,51 @@
<doxygenlayout version="1.0">
<!-- Generated by doxygen 1.8.7 -->
<!-- Generated by doxygen 1.9.4 -->
<!-- Navigation index tabs for HTML output -->
<navindex>
<tab type="mainpage" visible="yes" title=""/>
<tab type="pages" visible="yes" title="" intro=""/>
<tab type="modules" visible="yes"
title="Reference"
intro="
The reference documentation is split into logical modules, as documented in
the user manual."/>

<tab type="usergroup" visible="yes" title="Indexes">
<tab type="classmembers" visible="yes"
title="Methods"
intro="
This is an index of all the methods with links to the
corresponding documentation."/>

<tab type="classlist" visible="yes"
title="Classes"
intro="
This is an index of all the classes in the library with links to the
corresponding documentation."/>

<tab type="filelist" visible="yes"
title="Files"
intro=""/>

<tab type="modules" visible="yes" title="" intro=""/>
<tab type="namespaces" visible="yes" title="">
<tab type="namespacelist" visible="yes" title="" intro=""/>
<tab type="namespacemembers" visible="yes" title="" intro=""/>
</tab>

<!-- We don't use what's below -->
<tab type="namespaces" visible="no" title="">
<tab type="namespacelist" visible="no" title="" intro=""/>
<tab type="namespacemembers" visible="no" title="" intro=""/>
<tab type="concepts" visible="yes" title="">
</tab>

<tab type="examples" visible="no" title="" intro=""/>

<tab type="classes" visible="no" title="">
<tab type="interfaces" visible="yes" title="">
<tab type="interfacelist" visible="yes" title="" intro=""/>
<tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="interfacehierarchy" visible="yes" title="" intro=""/>
</tab>
<tab type="classes" visible="yes" title="">
<tab type="classlist" visible="yes" title="" intro=""/>
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="hierarchy" visible="no" title="" intro=""/>
<tab type="hierarchy" visible="yes" title="" intro=""/>
<tab type="classmembers" visible="yes" title="" intro=""/>
</tab>

<tab type="files" visible="no" title="Files">
<tab type="globals" visible="no" title="Globals" intro=""/>
<tab type="structs" visible="yes" title="">
<tab type="structlist" visible="yes" title="" intro=""/>
<tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
</tab>
<tab type="exceptions" visible="yes" title="">
<tab type="exceptionlist" visible="yes" title="" intro=""/>
<tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
</tab>
<tab type="files" visible="yes" title="">
<tab type="filelist" visible="yes" title="" intro=""/>
<tab type="globals" visible="yes" title="" intro=""/>
</tab>
<tab type="examples" visible="yes" title="" intro=""/>
</navindex>

<!-- Layout definition for a class page -->
<class>
<briefdescription visible="no"/>
<detaileddescription title="Description"/>

<includes visible="$SHOW_INCLUDE_FILES"/>
<briefdescription visible="yes"/>
<includes visible="$SHOW_HEADERFILE"/>
<inheritancegraph visible="$CLASS_GRAPH"/>
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
<memberdecl>
<related title="Synopsis of methods" subtitle=" "/>
<nestedclasses visible="yes" title="Instances and minimal complete definitions"/>
<friends title=""/>
<membergroups visible="yes"/>

<!-- We don't use what's below -->
<nestedclasses visible="yes" title=""/>
<publictypes title=""/>
<services title=""/>
<interfaces title=""/>
Expand Down Expand Up @@ -90,19 +74,21 @@ corresponding documentation."/>
<privatestaticmethods title=""/>
<privateattributes title=""/>
<privatestaticattributes title=""/>
<friends title=""/>
<related title="" subtitle=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<related title="Methods"/>
<functions title=""/>
<variables title=""/>
<inlineclasses title=""/>
<typedefs title=""/>
<enums title=""/>

<!-- This is not for C++ -->
<services title=""/>
<interfaces title=""/>
<constructors title=""/>
<functions title=""/>
<related title=""/>
<variables title=""/>
<properties title=""/>
<events title=""/>
</memberdef>
Expand All @@ -117,8 +103,14 @@ corresponding documentation."/>
<memberdecl>
<nestednamespaces visible="yes" title=""/>
<constantgroups visible="yes" title=""/>
<interfaces visible="yes" title=""/>
<classes visible="yes" title=""/>
<concepts visible="yes" title=""/>
<structs visible="yes" title=""/>
<exceptions visible="yes" title=""/>
<typedefs title=""/>
<sequences title=""/>
<dictionaries title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
Expand All @@ -128,13 +120,24 @@ corresponding documentation."/>
<memberdef>
<inlineclasses title=""/>
<typedefs title=""/>
<sequences title=""/>
<dictionaries title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
</memberdef>
<authorsection visible="yes"/>
</namespace>

<!-- Layout definition for a concept page -->
<concept>
<briefdescription visible="yes"/>
<includes visible="$SHOW_HEADERFILE"/>
<definition visible="yes" title=""/>
<detaileddescription title=""/>
<authorsection visible="yes"/>
</concept>

<!-- Layout definition for a file page -->
<file>
<briefdescription visible="yes"/>
Expand All @@ -143,11 +146,17 @@ corresponding documentation."/>
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
<sourcelink visible="yes"/>
<memberdecl>
<interfaces visible="yes" title=""/>
<classes visible="yes" title=""/>
<structs visible="yes" title=""/>
<exceptions visible="yes" title=""/>
<namespaces visible="yes" title=""/>
<concepts visible="yes" title=""/>
<constantgroups visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
<sequences title=""/>
<dictionaries title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
Expand All @@ -158,6 +167,8 @@ corresponding documentation."/>
<inlineclasses title=""/>
<defines title=""/>
<typedefs title=""/>
<sequences title=""/>
<dictionaries title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
Expand All @@ -167,18 +178,19 @@ corresponding documentation."/>

<!-- Layout definition for a group page -->
<group>
<briefdescription visible="no"/>
<detaileddescription title="Description"/>

<briefdescription visible="yes"/>
<groupgraph visible="$GROUP_GRAPHS"/>
<memberdecl>
<nestedgroups visible="yes" title=""/>
<dirs visible="yes" title=""/>
<files visible="yes" title=""/>
<namespaces visible="yes" title=""/>
<concepts visible="yes" title=""/>
<classes visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
<sequences title=""/>
<dictionaries title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>
Expand All @@ -192,11 +204,14 @@ corresponding documentation."/>
<friends title=""/>
<membergroups visible="yes"/>
</memberdecl>
<detaileddescription title=""/>
<memberdef>
<pagedocs/>
<inlineclasses title=""/>
<defines title=""/>
<typedefs title=""/>
<sequences title=""/>
<dictionaries title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>
Expand Down
Loading

0 comments on commit 003f42c

Please sign in to comment.