Skip to content

Commit

Permalink
Finished API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@theZiz
theZiz committed Oct 9, 2018
1 parent b7174da commit 6540995
Show file tree
Hide file tree
Showing 164 changed files with 7,075 additions and 4,447 deletions.
2 changes: 2 additions & 0 deletions documentation/Doxyfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -791,6 +791,7 @@ WARN_LOGFILE =
# Note: If this tag is empty the current directory is searched.

INPUT = ../include/
INPUT += ../examples/common/AlpakaAllocator.hpp

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down Expand Up @@ -874,6 +875,7 @@ RECURSIVE = YES
# run.

EXCLUDE = ../include/llama/DatumCoord.hpp
EXCLUDE += ../include/llama/Tuple.hpp

# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
Expand Down
7 changes: 7 additions & 0 deletions documentation/Makefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,12 @@ help:
@find doxygen/xml -type f -exec sed -i "s/llama::VirtualDatum< T_View >::/llama::VirtualDatum::/g" {} \;
@find doxygen/xml -type f -exec sed -i "s/llama::View< T_Mapping, T_BlobType >::/llama::View::/g" {} \;
@find doxygen/xml -type f -exec sed -i "s/<definition>using llama::VirtualView&lt; T_ParentViewType &gt;::/<definition>using llama::VirtualView::/g" {} \;
@find doxygen/xml -type f -exec sed -i "s/<definition>using llama::Tuple&lt; T_Elements &gt;::/<definition>using llama::Tuple::/g" {} \;
@find doxygen/xml -type f -exec sed -i "s/<definition>using llama::allocator::Vector&lt; T_alignment &gt;::/<definition>using llama::allocator::Vector::/g" {} \;
@find doxygen/xml -type f -exec sed -i "s/<definition>using llama::allocator::SharedPtr&lt; T_alignment &gt;::/<definition>using llama::allocator::SharedPtr::/g" {} \;
@find doxygen/xml -type f -exec sed -i "s/<definition>using llama::allocator::Stack&lt; reserved &gt;::/<definition>using llama::allocator::Stack::/g" {} \;
@find doxygen/xml -type f -exec sed -i "s/<definition>using common::allocator::Alpaka&lt; T_DevAcc, T_Size &gt;::/<definition>using common::allocator::Alpaka::/g" {} \;
@find doxygen/xml -type f -exec sed -i "s/<definition>using common::allocator::AlpakaMirror&lt; T_DevAcc, T_Size, T_Mapping &gt;::/<definition>using common::allocator::AlpakaMirror::/g" {} \;
@find doxygen/xml -type f -exec sed -i "s/<definition>using common::allocator::AlpakaShared&lt; T_Acc, T_count, T_uniqueID &gt;::/<definition>using common::allocator::AlpakaShared::/g" {} \;
# running sphinx-build while ignoring a warning generated by breathe from valid doxygen code
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 2>&1 | grep -v "WARNING: Duplicate declaration."
175 changes: 175 additions & 0 deletions documentation/doxygen/xml/AlpakaAllocator_8hpp.xml
View file

Large diffs are not rendered by default.

166 changes: 83 additions & 83 deletions documentation/doxygen/xml/AoS_8hpp.xml
View file

Large diffs are not rendered by default.

130 changes: 65 additions & 65 deletions documentation/doxygen/xml/Array_8hpp.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,181 +7,181 @@
<includedby refid="View_8hpp" local="yes">/home/alexander/develop/work/llama/include/llama/View.hpp</includedby>
<includedby refid="IntegerSequence_8hpp" local="yes">/home/alexander/develop/work/llama/include/llama/IntegerSequence.hpp</includedby>
<incdepgraph>
<node id="20">
<node id="22">
<label>boost/predef.h</label>
</node>
<node id="18">
<node id="20">
<label>/home/alexander/develop/work/llama/include/llama/Array.hpp</label>
<link refid="Array_8hpp"/>
<childnode refid="19" relation="include">
<childnode refid="21" relation="include">
</childnode>
</node>
<node id="19">
<node id="21">
<label>preprocessor/macros.hpp</label>
<link refid="macros_8hpp"/>
<childnode refid="20" relation="include">
<childnode refid="22" relation="include">
</childnode>
</node>
</incdepgraph>
<invincdepgraph>
<node id="22">
<node id="24">
<label>/home/alexander/develop/work/llama/include/llama/Types.hpp</label>
<link refid="Types_8hpp"/>
<childnode refid="23" relation="include">
<childnode refid="25" relation="include">
</childnode>
<childnode refid="35" relation="include">
<childnode refid="37" relation="include">
</childnode>
<childnode refid="36" relation="include">
<childnode refid="38" relation="include">
</childnode>
<childnode refid="28" relation="include">
<childnode refid="30" relation="include">
</childnode>
<childnode refid="37" relation="include">
<childnode refid="39" relation="include">
</childnode>
<childnode refid="32" relation="include">
<childnode refid="34" relation="include">
</childnode>
<childnode refid="38" relation="include">
<childnode refid="40" relation="include">
</childnode>
<childnode refid="39" relation="include">
<childnode refid="41" relation="include">
</childnode>
</node>
<node id="25">
<node id="27">
<label>/home/alexander/develop/work/llama/include/llama/CompareUID.hpp</label>
<link refid="CompareUID_8hpp"/>
<childnode refid="26" relation="include">
<childnode refid="28" relation="include">
</childnode>
</node>
<node id="28">
<node id="30">
<label>/home/alexander/develop/work/llama/include/llama/llama.hpp</label>
<link refid="llama_8hpp"/>
</node>
<node id="39">
<node id="41">
<label>/home/alexander/develop/work/llama/include/llama/mapping/Interface.hpp</label>
<link refid="Interface_8hpp"/>
</node>
<node id="21">
<node id="23">
<label>/home/alexander/develop/work/llama/include/llama/Array.hpp</label>
<link refid="Array_8hpp"/>
<childnode refid="22" relation="include">
<childnode refid="24" relation="include">
</childnode>
<childnode refid="26" relation="include">
<childnode refid="28" relation="include">
</childnode>
<childnode refid="40" relation="include">
<childnode refid="42" relation="include">
</childnode>
</node>
<node id="34">
<node id="36">
<label>/home/alexander/develop/work/llama/include/llama/ForEach.hpp</label>
<link refid="ForEach_8hpp"/>
<childnode refid="26" relation="include">
</childnode>
<childnode refid="28" relation="include">
</childnode>
<childnode refid="30" relation="include">
</childnode>
</node>
<node id="37">
<node id="39">
<label>/home/alexander/develop/work/llama/include/llama/mapping/AoS.hpp</label>
<link refid="AoS_8hpp"/>
<childnode refid="28" relation="include">
<childnode refid="30" relation="include">
</childnode>
</node>
<node id="26">
<node id="28">
<label>/home/alexander/develop/work/llama/include/llama/View.hpp</label>
<link refid="View_8hpp"/>
<childnode refid="27" relation="include">
</childnode>
<childnode refid="29" relation="include">
</childnode>
<childnode refid="31" relation="include">
</childnode>
</node>
<node id="23">
<node id="25">
<label>/home/alexander/develop/work/llama/include/llama/DatumStruct.hpp</label>
<link refid="DatumStruct_8hpp"/>
<childnode refid="24" relation="include">
</childnode>
<childnode refid="30" relation="include">
<childnode refid="26" relation="include">
</childnode>
<childnode refid="31" relation="include">
<childnode refid="32" relation="include">
</childnode>
<childnode refid="33" relation="include">
</childnode>
<childnode refid="28" relation="include">
<childnode refid="35" relation="include">
</childnode>
<childnode refid="30" relation="include">
</childnode>
</node>
<node id="36">
<node id="38">
<label>/home/alexander/develop/work/llama/include/llama/UserDomain.hpp</label>
<link refid="UserDomain_8hpp"/>
<childnode refid="35" relation="include">
<childnode refid="37" relation="include">
</childnode>
<childnode refid="28" relation="include">
<childnode refid="30" relation="include">
</childnode>
<childnode refid="37" relation="include">
<childnode refid="39" relation="include">
</childnode>
<childnode refid="32" relation="include">
<childnode refid="34" relation="include">
</childnode>
<childnode refid="38" relation="include">
<childnode refid="40" relation="include">
</childnode>
</node>
<node id="32">
<node id="34">
<label>/home/alexander/develop/work/llama/include/llama/mapping/SoA.hpp</label>
<link refid="SoA_8hpp"/>
<childnode refid="28" relation="include">
<childnode refid="30" relation="include">
</childnode>
</node>
<node id="35">
<node id="37">
<label>/home/alexander/develop/work/llama/include/llama/mapping/One.hpp</label>
<link refid="One_8hpp"/>
<childnode refid="27" relation="include">
<childnode refid="29" relation="include">
</childnode>
<childnode refid="28" relation="include">
<childnode refid="30" relation="include">
</childnode>
</node>
<node id="33">
<node id="35">
<label>/home/alexander/develop/work/llama/include/llama/GetCoordFromUID.hpp</label>
<link refid="GetCoordFromUID_8hpp"/>
<childnode refid="34" relation="include">
<childnode refid="36" relation="include">
</childnode>
</node>
<node id="40">
<node id="42">
<label>/home/alexander/develop/work/llama/include/llama/IntegerSequence.hpp</label>
<link refid="IntegerSequence_8hpp"/>
<childnode refid="36" relation="include">
<childnode refid="38" relation="include">
</childnode>
<childnode refid="27" relation="include">
<childnode refid="29" relation="include">
</childnode>
</node>
<node id="30">
<node id="32">
<label>/home/alexander/develop/work/llama/include/llama/DatumArray.hpp</label>
<link refid="DatumArray_8hpp"/>
<childnode refid="28" relation="include">
<childnode refid="30" relation="include">
</childnode>
</node>
<node id="27">
<node id="29">
<label>/home/alexander/develop/work/llama/include/llama/Factory.hpp</label>
<link refid="Factory_8hpp"/>
<childnode refid="28" relation="include">
<childnode refid="30" relation="include">
</childnode>
</node>
<node id="31">
<node id="33">
<label>/home/alexander/develop/work/llama/include/llama/GetType.hpp</label>
<link refid="GetType_8hpp"/>
<childnode refid="26" relation="include">
<childnode refid="28" relation="include">
</childnode>
<childnode refid="32" relation="include">
<childnode refid="34" relation="include">
</childnode>
</node>
<node id="29">
<node id="31">
<label>/home/alexander/develop/work/llama/include/llama/VirtualView.hpp</label>
<link refid="VirtualView_8hpp"/>
<childnode refid="28" relation="include">
<childnode refid="30" relation="include">
</childnode>
</node>
<node id="38">
<node id="40">
<label>/home/alexander/develop/work/llama/include/llama/mapping/tree/Mapping.hpp</label>
<link refid="Mapping_8hpp"/>
<childnode refid="28" relation="include">
<childnode refid="30" relation="include">
</childnode>
</node>
<node id="24">
<node id="26">
<label>/home/alexander/develop/work/llama/include/llama/GetUID.hpp</label>
<link refid="GetUID_8hpp"/>
<childnode refid="25" relation="include">
<childnode refid="27" relation="include">
</childnode>
</node>
</invincdepgraph>
Expand Down

0 comments on commit 6540995

Please sign in to comment.