Skip to content

P
paho.mqtt.c
Commit 56ad6720 authored by Ian Craggs's avatar Ian Craggs
Browse files
Options

Product Doxygen doc

parent 19bedf93
Hide whitespace changes
Inline Side-by-side
Showing with 18 additions and 27 deletions
build.xml
View file @ 56ad6720
...@@ -182,30 +182,22 @@ ...@@ -182,30 +182,22 @@
<target name="doc" > <target name="doc" >
<if> <if>
<available file="${doxygen}"/> <available file="/usr/bin/doxygen"/>
<then> <then>
<exec executable="${doxygen}" dir="${mqttclient_src}"> <mkdir dir="${output.folder}/doc"/>
<arg value="${source.folder}/mqttv3c/doc/DoxyfileV3ClientAPI"/> <exec executable="doxygen" dir="src">
<arg value="../doc/DoxyfileV3ClientAPI"/>
</exec> </exec>
<mkdir dir="${ship.folder}/doc/html"/> <exec executable="doxygen" dir="src">
<copy todir="${ship.folder}/doc/html"> <arg value="../doc/DoxyfileV3AsyncAPI"/>
<fileset dir="${mqttclient_src}/MQTTClient/html"/>
</copy>
<!-- <zip destfile="${output.folder}/doc/MQTTClient.zip">
<zipfileset dir="${mqttclient_src}/MQTTClient" />
</zip> -->
<exec executable="${doxygen}" dir="${mqttclient_src}">
<arg value="${source.folder}/mqttv3c/doc/DoxyfileV3AsyncAPI"/>
</exec> </exec>
<mkdir dir="${ship.folder}/doc/html/MQTTAsync"/> <zip destfile="${output.folder}/MQTTClient_doc.zip">
<copy todir="${ship.folder}/doc/html/MQTTAsync"> <zipfileset dir="${output.folder}/doc/MQTTClient" />
<fileset dir="${mqttclient_src}/MQTTAsync"/> </zip>
</copy> <zip destfile="${output.folder}/MQTTAsync_doc.zip">
<!-- <zip destfile="${output.folder}/doc/MQTTAsync.zip"> <zipfileset dir="${output.folder}/doc/MQTTAsync" prefix="MQTTAsync/"/>
<zipfileset dir="${mqttclient_src}/MQTTAsync" prefix="MQTTAsync/"/> </zip>
</zip> --> <delete dir="${output.folder}/doc" />
<delete dir="${mqttclient_src}/MQTTClient" />
<delete dir="${mqttclient_src}/MQTTAsync" />
</then> </then>
<else> <else>
<echo message="doxygen is not available" /> <echo message="doxygen is not available" />
...@@ -232,7 +224,6 @@ ...@@ -232,7 +224,6 @@
</copy> </copy>
</target> </target>
<!-- target name="full" depends="init, version, compile, test, doc, copy" --> <target name="full" depends="init, version, compile, test, doc" />
<target name="full" depends="init, version, compile, test" />
</project> </project>
doc/DoxyfileV3AsyncAPI
View file @ 56ad6720
...@@ -26,7 +26,7 @@ DOXYFILE_ENCODING = UTF-8 ...@@ -26,7 +26,7 @@ DOXYFILE_ENCODING = UTF-8
# identify the project. Note that if you do not use Doxywizard you need # identify the project. Note that if you do not use Doxywizard you need
# to put quotes around the project name if it contains spaces. # to put quotes around the project name if it contains spaces.
PROJECT_NAME = "Asynchronous MQTT Client" PROJECT_NAME = "Paho Asynchronous MQTT C Client Library"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. # The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or # This could be handy for archiving the generated documentation or
...@@ -52,7 +52,7 @@ PROJECT_LOGO = "../doc/pahologo.png" ...@@ -52,7 +52,7 @@ PROJECT_LOGO = "../doc/pahologo.png"
# If a relative path is entered, it will be relative to the location # If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used. # where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = "MQTTAsync/" OUTPUT_DIRECTORY = "../build/output/doc/MQTTAsync/"
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output # 4096 sub-directories (in 2 levels) under the output directory of each output
......
doc/DoxyfileV3ClientAPI
View file @ 56ad6720
...@@ -26,7 +26,7 @@ DOXYFILE_ENCODING = UTF-8 ...@@ -26,7 +26,7 @@ DOXYFILE_ENCODING = UTF-8
# identify the project. Note that if you do not use Doxywizard you need # identify the project. Note that if you do not use Doxywizard you need
# to put quotes around the project name if it contains spaces. # to put quotes around the project name if it contains spaces.
PROJECT_NAME = "MQTT Client" PROJECT_NAME = "Paho MQTT C Client Library"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. # The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or # This could be handy for archiving the generated documentation or
...@@ -52,7 +52,7 @@ PROJECT_LOGO = "../doc/pahologo.png" ...@@ -52,7 +52,7 @@ PROJECT_LOGO = "../doc/pahologo.png"
# If a relative path is entered, it will be relative to the location # If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used. # where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = "MQTTClient/" OUTPUT_DIRECTORY = "../build/output/doc/MQTTClient/"
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output # 4096 sub-directories (in 2 levels) under the output directory of each output
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment