You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by jr...@apache.org on 2015/11/17 22:11:54 UTC

svn commit: r1714893 - in /qpid/site: python/generate.py scripts/gen-proton-release-api-doc

Author: jross
Date: Tue Nov 17 21:11:54 2015
New Revision: 1714893

URL: http://svn.apache.org/viewvc?rev=1714893&view=rev
Log:
PROTON-1022: Configure the example path for the C++ Proton API reference

Modified:
    qpid/site/python/generate.py
    qpid/site/scripts/gen-proton-release-api-doc

Modified: qpid/site/python/generate.py
URL: http://svn.apache.org/viewvc/qpid/site/python/generate.py?rev=1714893&r1=1714892&r2=1714893&view=diff
==============================================================================
--- qpid/site/python/generate.py (original)
+++ qpid/site/python/generate.py Tue Nov 17 21:11:54 2015
@@ -163,6 +163,7 @@ def export_release_from_git(module, rele
 _doxygen_conf_template = u"""
 DISABLE_INDEX = yes
 EXTRACT_ALL = yes
+EXAMPLE_PATH = {example_paths}
 GENERATE_HTML = yes
 GENERATE_LATEX = no
 GENERATE_TREEVIEW = yes
@@ -176,10 +177,12 @@ STRIP_FROM_PATH = {strip_paths}
 HTML_OUTPUT = {output_dir}
 """
 
-def gen_doxygen(release, title, input_paths, strip_paths, output_dir):
+def gen_doxygen(release, title, input_paths, strip_paths, output_dir,
+                example_paths=[]):
     input_paths = " ".join(input_paths)
     strip_paths = " ".join(strip_paths)
-
+    example_paths = " ".join(example_paths)
+    
     make_dir(output_dir)
 
     conf = _doxygen_conf_template.format(**locals())

Modified: qpid/site/scripts/gen-proton-release-api-doc
URL: http://svn.apache.org/viewvc/qpid/site/scripts/gen-proton-release-api-doc?rev=1714893&r1=1714892&r2=1714893&view=diff
==============================================================================
--- qpid/site/scripts/gen-proton-release-api-doc (original)
+++ qpid/site/scripts/gen-proton-release-api-doc Tue Nov 17 21:11:54 2015
@@ -60,7 +60,8 @@ def gen_cpp_api_doc(release, source_dir,
                              join(source_dir, "examples", "cpp", "README.hpp")
                 ),
                 strip_paths=(include_dir),
-                output_dir=output_dir)
+                output_dir=output_dir,
+                example_paths=(join(source_dir, "examples", "cpp"),))
 
 def gen_java_api_doc(release, source_dir, component_dir):
     input_path = join(source_dir, "proton-j", "src", "main", "java")



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org