docs
This commit is contained in:
Vitor Santos Costa
@@ -2,8 +2,6 @@
|
||||
if (WITH_DOCS)
|
||||
|
||||
|
||||
|
||||
|
||||
set (TOP_DIR YES)
|
||||
|
||||
set(DOCS_SOURCE_DIR ${CMAKE_SOURCE_DIR}/docs)
|
||||
@@ -39,6 +37,8 @@ ${CMAKE_SOURCE_DIR}/build
|
||||
${CMAKE_SOURCE_DIR}/Debug
|
||||
${CMAKE_SOURCE_DIR}/packages/jpl
|
||||
${CMAKE_SOURCE_DIR}/packages/swig
|
||||
${CMAKE_SOURCE_DIR}/packages/Problog/problog_examples/output
|
||||
${CMAKE_SOURCE_DIR}/packages/Problog/problog_examples/queries
|
||||
${CMAKE_SOURCE_DIR}/packages/myddas/sqlite3/src
|
||||
${CMAKE_SOURCE_DIR}/packages/gecode/4.4.0
|
||||
${CMAKE_SOURCE_DIR}/packages/gecode/4.2.1
|
||||
@@ -59,7 +59,6 @@ ${CMAKE_SOURCE_DIR}/packages/prosqlite
|
||||
${CMAKE_SOURCE_DIR}/packages/pyswip
|
||||
${CMAKE_SOURCE_DIR}/packages/yap-lbfgs/liblbfgs-1.10
|
||||
${CMAKE_SOURCE_DIR}/library/dialect/swi/os
|
||||
${CMAKE_SOURCE_DIR}/packages/python
|
||||
${CMAKE_SOURCE_DIR}/*/bprolog/*
|
||||
${CMAKE_SOURCE_DIR}/*/prism/*
|
||||
${CMAKE_SOURCE_DIR}/*/gecodde/[345]*
|
||||
@@ -73,7 +72,6 @@ ${CMAKE_SOURCE_DIR}/*/bprolog/*
|
||||
${CMAKE_SOURCE_DIR}/packages/gecode/gecode4_yap_hand_written.yap
|
||||
${CMAKE_SOURCE_DIR}/packages/gecode/gecode5_yap_hand_written.yap
|
||||
*/CMakeFiles/* *~ */#*
|
||||
|
||||
)
|
||||
|
||||
|
||||
@@ -120,12 +118,7 @@ endforeach(i ${DOC_INPUT_FILES_})
|
||||
|
||||
add_custom_target(docs
|
||||
COMMAND ${DOXYGEN_EXECUTABLE} ${doxyfile}
|
||||
COMMAND ${CMAKE_COMMAND} -E COPY ${CMAKE_SOURCE_DIR}/docs/custom/assets html/assets/
|
||||
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
||||
COMMENT "Generating API documentation with Doxygen"
|
||||
VERBATIM
|
||||
DEPENDS ${DEPENDS})
|
||||
|
||||
)
|
||||
|
||||
|
||||
if (EXISTS ${CMAKE_CURRENT_BINARY_DIR}/html)
|
||||
|
||||
@@ -884,7 +884,7 @@ RECURSIVE = YES
|
||||
# Note that relative paths are relative to the directory from which doxygen is
|
||||
# run.
|
||||
|
||||
EXCLUDE = @DOCS_EXCLUDE@
|
||||
EXCLUDE =
|
||||
|
||||
# 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
|
||||
@@ -892,7 +892,7 @@ EXCLUDE = @DOCS_EXCLUDE@
|
||||
# The default value is: NO.
|
||||
|
||||
EXCLUDE_SYMLINKS = NO
|
||||
|
||||
|
||||
# If the value of the INPUT tag contains directories, you can use the
|
||||
# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
|
||||
# certain files from those directories.
|
||||
@@ -2072,14 +2072,14 @@ MACRO_EXPANSION = YES
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
||||
|
||||
EXPAND_ONLY_PREDEF = YES
|
||||
EXPAND_ONLY_PREDEF = NO
|
||||
|
||||
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
|
||||
# INCLUDE_PATH will be searched if a #include is found.
|
||||
# The default value is: YES.
|
||||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
||||
|
||||
SEARCH_INCLUDES = NO
|
||||
SEARCH_INCLUDES = YES
|
||||
|
||||
# The INCLUDE_PATH tag can be used to specify one or more directories that
|
||||
# contain include files that are not input files but should be processed by the
|
||||
@@ -2109,20 +2109,20 @@ INCLUDE_FILE_PATTERNS =
|
||||
# recursively expanded use the := operator instead of the = operator.
|
||||
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
|
||||
|
||||
PREDEFINED =
|
||||
YAP_FLAG(ITEM,NAME,WRITABLE,DEF,INIT,HELPER)=ITEM \
|
||||
START_LOCAL_FLAGS="enum THREAD_LOCAL_FLAGS {" \
|
||||
END_LOCAL_FLAGS=" };"\
|
||||
START_GLOBAL_FLAGS="enum GLOBAL_FLAGS {" \
|
||||
END_GLOBAL_FLAGS="};" \
|
||||
LOCAL(A, B)="A B" \
|
||||
LOCAL_INIT(A, B, C)="A B;B = C" \
|
||||
LOCAL_ARRAY(A, B, C)="A B[C]" \
|
||||
LOCAL_ARRAY_ARRAY(A, B, C,D)="A B[C][D]"\
|
||||
LOCAL_INIT(A, B, C, D)="A B[C][D]"\
|
||||
LOCAL_INITF(A, B, C)=" A B; C"\
|
||||
LOCAL_INIT_RESTORE(A,B,C,D)="A B; C; D;"\
|
||||
PREG=Yap_REGS.P_
|
||||
PREDEFINED = #
|
||||
# YAP_FLAG(ITEM,NAME,WRITABLE,DEF,INIT,HELPER)=ITEM \
|
||||
# START_LOCAL_FLAGS="enum THREAD_LOCAL_FLAGS {" \
|
||||
# END_LOCAL_FLAGS=" };"\
|
||||
# START_GLOBAL_FLAGS="enum GLOBAL_FLAGS {" \
|
||||
# END_GLOBAL_FLAGS="};" \
|
||||
# LOCAL(A, B)="A B" \
|
||||
# LOCAL_INIT(A, B, C)="A B;B = C" \
|
||||
# LOCAL_ARRAY(A, B, C)="A B[C]" \
|
||||
# LOCAL_ARRAY_ARRAY(A, B, C,D)="A B[C][D]"\
|
||||
# LOCAL_INIT(A, B, C, D)="A B[C][D]"\
|
||||
# LOCAL_INITF(A, B, C)=" A B; C"\
|
||||
# LOCAL_INIT_RESTORE(A,B,C,D)="A B; C; D;"\
|
||||
# PREG=Yap_REGS.P_
|
||||
|
||||
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
|
||||
# tag can be used to specify a list of macro names that should be expanded. The
|
||||
|
||||
194
docs/custom/DoxygenLayout.xml
Normal file
194
docs/custom/DoxygenLayout.xml
Normal file
@@ -0,0 +1,194 @@
|
||||
<doxygenlayout version="1.0">
|
||||
<!-- Generated by doxygen 1.8.15 -->
|
||||
<!-- 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="" intro=""/>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespacelist" visible="yes" title="" intro=""/>
|
||||
<tab type="namespacemembers" 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="yes" title="" intro=""/>
|
||||
<tab type="classmembers" 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="yes"/>
|
||||
<includes visible="$SHOW_INCLUDE_FILES"/>
|
||||
<inheritancegraph visible="$CLASS_GRAPH"/>
|
||||
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
|
||||
<memberdecl>
|
||||
<nestedclasses visible="yes" title=""/>
|
||||
<publictypes title=""/>
|
||||
<services title=""/>
|
||||
<interfaces title=""/>
|
||||
<publicslots title=""/>
|
||||
<signals title=""/>
|
||||
<publicmethods title=""/>
|
||||
<publicstaticmethods title=""/>
|
||||
<publicattributes title=""/>
|
||||
<publicstaticattributes title=""/>
|
||||
<protectedtypes title=""/>
|
||||
<protectedslots title=""/>
|
||||
<protectedmethods title=""/>
|
||||
<protectedstaticmethods title=""/>
|
||||
<protectedattributes title=""/>
|
||||
<protectedstaticattributes title=""/>
|
||||
<packagetypes title=""/>
|
||||
<packagemethods title=""/>
|
||||
<packagestaticmethods title=""/>
|
||||
<packageattributes title=""/>
|
||||
<packagestaticattributes title=""/>
|
||||
<properties title=""/>
|
||||
<events title=""/>
|
||||
<privatetypes title=""/>
|
||||
<privateslots title=""/>
|
||||
<privatemethods title=""/>
|
||||
<privatestaticmethods title=""/>
|
||||
<privateattributes title=""/>
|
||||
<privatestaticattributes title=""/>
|
||||
<friends title=""/>
|
||||
<related title="" subtitle=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<inlineclasses title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<services title=""/>
|
||||
<interfaces title=""/>
|
||||
<constructors title=""/>
|
||||
<functions title=""/>
|
||||
<related title=""/>
|
||||
<variables title=""/>
|
||||
<properties title=""/>
|
||||
<events title=""/>
|
||||
</memberdef>
|
||||
<allmemberslink visible="yes"/>
|
||||
<usedfiles visible="$SHOW_USED_FILES"/>
|
||||
<authorsection visible="yes"/>
|
||||
</class>
|
||||
|
||||
<!-- Layout definition for a namespace page -->
|
||||
<namespace>
|
||||
<briefdescription visible="yes"/>
|
||||
<memberdecl>
|
||||
<nestednamespaces visible="yes" title=""/>
|
||||
<constantgroups visible="yes" title=""/>
|
||||
<classes visible="no" title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<inlineclasses title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
</memberdef>
|
||||
<authorsection visible="yes"/>
|
||||
</namespace>
|
||||
|
||||
<!-- Layout definition for a file page -->
|
||||
<file>
|
||||
<briefdescription visible="yes"/>
|
||||
<includes visible="$SHOW_INCLUDE_FILES"/>
|
||||
<includegraph visible="$INCLUDE_GRAPH"/>
|
||||
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
|
||||
<sourcelink visible="yes"/>
|
||||
<memberdecl>
|
||||
<classes visible="no" title=""/>
|
||||
<namespaces visible="yes" title=""/>
|
||||
<constantgroups visible="yes" title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<inlineclasses title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
</memberdef>
|
||||
<authorsection/>
|
||||
</file>
|
||||
|
||||
<!-- Layout definition for a group page -->
|
||||
<group>
|
||||
<briefdescription visible="yes"/>
|
||||
<detaileddescription title=""/>
|
||||
<groupgraph visible="$GROUP_GRAPHS"/>
|
||||
<memberdecl>
|
||||
<nestedgroups visible="yes" title=""/>
|
||||
<dirs visible="yes" title=""/>
|
||||
<files visible="yes" title=""/>
|
||||
<namespaces visible="yes" title=""/>
|
||||
<classes visible="no" title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<enumvalues title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<signals title=""/>
|
||||
<publicslots title=""/>
|
||||
<protectedslots title=""/>
|
||||
<privateslots title=""/>
|
||||
<events title=""/>
|
||||
<properties title=""/>
|
||||
<friends title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<memberdef>
|
||||
<pagedocs/>
|
||||
<inlineclasses title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<enumvalues title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<signals title=""/>
|
||||
<publicslots title=""/>
|
||||
<protectedslots title=""/>
|
||||
<privateslots title=""/>
|
||||
<events title=""/>
|
||||
<properties title=""/>
|
||||
<friends title=""/>
|
||||
</memberdef>
|
||||
<authorsection visible="yes"/>
|
||||
</group>
|
||||
|
||||
<!-- Layout definition for a directory page -->
|
||||
<directory>
|
||||
<briefdescription visible="yes"/>
|
||||
<directorygraph visible="yes"/>
|
||||
<memberdecl>
|
||||
<dirs visible="yes"/>
|
||||
<files visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
</directory>
|
||||
</doxygenlayout>
|
||||
@@ -1,20 +1,20 @@
|
||||
YAP packages {#packages}
|
||||
============
|
||||
|
||||
+ @subpage realmd
|
||||
+ @ref real
|
||||
|
||||
+ @subpage BDDs
|
||||
+ @subpage BDDs
|
||||
|
||||
+ @subpage gecode
|
||||
|
||||
+ @subpage myddas
|
||||
+ @ref myddas
|
||||
|
||||
+ @ref PFL
|
||||
|
||||
+ @subpage ProbLog1
|
||||
|
||||
+ @ref Python
|
||||
x
|
||||
+ @ref python
|
||||
|
||||
+ @subpage raptor
|
||||
|
||||
+ @ref YAP-LBFGS
|
||||
|
||||
Reference in New Issue
Block a user