remove the old doxygen documentation

CMakeLists.txt

@@ -461,25 +461,14 @@ if(BUILD_EXAMPLES)
 endif()
 
 # build documentation
-option(BUILD_DOCUMENTATION "Generate doxygen/sphinx documentation" OFF)
+option(BUILD_DOCUMENTATION "Generate documentation" OFF)
 if(BUILD_DOCUMENTATION)
-    find_package(Doxygen REQUIRED)
     find_package(Sphinx REQUIRED)
-    configure_file(${PROJECT_SOURCE_DIR}/doc/Doxyfile.in ${PROJECT_BINARY_DIR}/Doxyfile @ONLY)
-    configure_file(${PROJECT_SOURCE_DIR}/doc/conf.py ${PROJECT_BINARY_DIR}/conf.py @ONLY)
-    add_custom_target(doxygen
-                      ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/Doxyfile
-                      WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
-                      COMMENT "Generating API documentation with Doxygen")
-    add_custom_target(latex ${SPHINX_EXECUTABLE}
-      -b latex -c "${PROJECT_BINARY_DIR}"
-      "${PROJECT_SOURCE_DIR}/doc" "${PROJECT_BINARY_DIR}/doc/sphinx"
-      DEPENDS doxygen
+    add_custom_target(doc_latex ${SPHINX_EXECUTABLE}
+      -b latex -c "${PROJECT_SOURCE_DIR}/doc" "${PROJECT_SOURCE_DIR}/doc" "${PROJECT_BINARY_DIR}/doc_latex"
       COMMENT "Building LaTeX sources for documentation with Sphinx")
     add_custom_target(doc ${SPHINX_EXECUTABLE}
-      -b html -c "${PROJECT_BINARY_DIR}"
-      "${PROJECT_SOURCE_DIR}/doc" "${PROJECT_BINARY_DIR}/doc/sphinx"
-      COMMAND ${CMAKE_COMMAND} -E copy "${PROJECT_SOURCE_DIR}/doc/open62541_html.png" "${PROJECT_BINARY_DIR}/doc/sphinx/_static/"
-      DEPENDS doxygen
+      -b html -c "${PROJECT_SOURCE_DIR}/doc" "${PROJECT_SOURCE_DIR}/doc" "${PROJECT_BINARY_DIR}/doc"
+      COMMAND ${CMAKE_COMMAND} -E copy "${PROJECT_SOURCE_DIR}/doc/open62541_html.png" "${PROJECT_BINARY_DIR}/doc/_static/"
       COMMENT "Building HTML documentation with Sphinx")
 endif()

doc/DoxygenLayout.xml

@@ -1,194 +0,0 @@
-<doxygenlayout version="1.0">
-  <!-- Generated by doxygen 1.8.6 -->
-  <!-- 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="no" title="">
-      <tab type="namespacelist" visible="yes" title="" intro=""/>
-      <tab type="namespacemembers" visible="yes" title="" intro=""/>
-    </tab>
-    <tab type="classes" visible="no" 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="no" 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="yes" 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="yes" 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="no"/>
-    <groupgraph visible="$GROUP_GRAPHS"/>
-    <detaileddescription title=""/>
-    <memberdecl>
-      <nestedgroups visible="yes" title=""/>
-      <dirs visible="yes" title=""/>
-      <files visible="yes" title=""/>
-      <namespaces visible="yes" title=""/>
-      <classes visible="yes" 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="no"/>
-  </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>

doc/conf.py

@@ -29,11 +29,7 @@ import shlex
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['breathe']
-
-breathe_projects = { "open62541-breathe": "doc/xml/" }
-breathe_default_project = "open62541-breathe"
-breathe_domain_by_extension = {"h" : "c", "c" : "c"}
+extensions = []
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -232,7 +228,7 @@ latex_documents = [
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-latex_logo = "doc/open62541.png"
+latex_logo = "open62541.png"
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.

doc/mainpage.dox

@@ -1,110 +0,0 @@
-/**
-\mainpage Open62541 Developer Documentation
-
-<a href="http://en.wikipedia.org/wiki/OPC_Unified_Architecture">OPC UA</a> (short for OPC Unified
-Architecture) is a protocol for industrial communication and has been standardized in the IEC62541.
-At its core, OPC UA defines a set of services to interact with a server-side object-oriented
-information model. Besides the service-calls initiated by the client, push-notification of remote
-events (such as data changes) can be negotiated with the server. The client/server interaction is
-mapped either to a binary encoding and TCP-based transmission or to SOAP-based webservices. As of
-late, OPC UA is marketed as the one standard for non-realtime industrial communication.
-
-We believe that it is best to understand OPC UA <em>from the inside out</em>, building upon conceptually
-simple first principles. After establishing a first understanding, we go on explaining how these
-principles are realized in detail. Examples are given based on the <em>open62541</em> implementation of the
-standard.
-
-<h2>OPC UA, a collection of services</h2>
-
-In OPC UA, all communication is based on service calls, each consisting of a request and a response
-message. Be careful to note the difference between services and methods. Services are pre-defined in
-the standard and cannot be changed. But you can use the <em>Call</em> service to invoke user-defined
-methods on the server.
-
-For completeness, the following tables contain all services defined in the standard. Do not bother
-with their details yet. We will introduce the different services later in the text. In open62541,
-each service is implemented in a single function. See the \ref services section for details.
-
-<b>Establishing communication</b>
-
-<table>
-<tr> <th>Discovery Service Set </th><th>SecureChannel Service Set </th><th>Session Service Set </th></tr>
-<tr> <td>FindServers </td><td>OpenSecureChannel </td><td>CreateSession </td></tr>
-<tr> <td>GetEndpoints </td><td>CloseSecureChannel </td><td>ActivateSession </td></tr>
-<tr> <td>RegisterServer </td><td></td><td>CloseSession </td></tr>
-<tr> <td></td><td></td><td>Cancel </td></tr>
-</table>
-
-<b>Interaction with the information model</b>
-
-<table>
-<tr> <th>NodeManagement Service Set </th><th>View Service Set </th><th>Query Service Set </th><th>Attribute Service Set </th><th>Method Service Set  </th></tr>
-<tr> <td>AddNodes </td><td>Browse </td><td>QueryFirst </td><td>Read </td><td>Call </td></tr>
-<tr> <td>AddReferences </td><td>BrowseNext </td><td>QueryNext </td><td>HistoryRead </td><td></td></tr>
-<tr> <td>DeleteNodes </td><td>TranslateBrowsePathsToNodeIds </td><td></td><td>Write </td><td></td></tr>
-<tr> <td>DeleteReferences </td><td>RegisterNodes </td><td></td><td>HistoryUpdate </td><td></td></tr>
-<tr> <td></td><td>UnregisterNodes </td><td></td><td></td><td></td></tr>
-</table>
-
-<b>Notifications</b>
-
-<table>
-<tr> <th>MonitoredItem Service Set </th><th>Subscription Service Set  </th></tr>
-<tr> <td>CreateMonitoredItems </td><td>CreateSubscription </td></tr>
-<tr> <td>ModifyMonitoredItems </td><td>ModifySubscription </td></tr>
-<tr> <td>SetMonitoringMode </td><td>SetPublishingMode </td></tr>
-<tr> <td>SetTriggering </td><td>Publish </td></tr>
-<tr> <td>DeleteMonitoredItems </td><td>Republish </td></tr>
-<tr> <td></td><td>TransferSubscription </td></tr>
-<tr> <td></td><td>DeleteSubscription </td></tr>
-</table>
-
-<h2>OPC UA, a web of nodes</h2>
-
-The information model in each OPC UA server is a web of interconnected nodes. There are eight
-different types of nodes. Depending on its type, every node contains different attributes. Some
-attributes, such as the <em>NodeId</em> (unique identifier) and the <em>BrowseName</em>, are
-contained in all node types.
-
-<table>
-<tr> <td>ReferenceTypeNode</td> <td>MethodNode</td> </tr>
-<tr> <td>DataTypeNode</td> <td>ObjectTypeNode</td> </tr>
-<tr> <td>VariableTypeNode</td> <td>ObjectNode</td> </tr>
-<tr> <td>VariableNode</td> <td>ViewNode</td> </tr>
-</table>
-                                                                                                            
-Nodes are interconnected by directed reference-triples of the form <dfn>(nodeid, referencetype,
-target-nodeid)</dfn>. Therefore an OPC UA information model is easiest imagined as a <em>web of nodes</em>.
-Reference types can be
-- standard- or user-defined and
-- either non-hierarchical (e.g., indicating the type of a variable-node) or hierarchical (e.g., indicating a parent-child relationship).
-
-<h2>OPC UA, a protocol</h2>
-
-The OPC UA protocol (both binary and XML-based) is based on 25 <em>built-in</em> datatypes. In
-open62541, these are defined in ua_types.h.
-
-<table>
-<tr> <td>Boolean</td> <td>Float</td> <td>StatusCode</td> </tr>
-<tr> <td>SByte</td> <td>Double</td> <td>QualifiedName</td> </tr>
-<tr> <td>Byte</td> <td>String</td> <td>LocalizedText</td> </tr>
-<tr> <td>Int16</td> <td>DateTime</td> <td>ExtensionObject</td> </tr>
-<tr> <td>UInt16</td> <td>Guid</td> <td>DataValue</td> </tr>
-<tr> <td>Int32</td> <td>ByteString</td> <td>Variant</td> </tr>
-<tr> <td>UInt32</td> <td>XmlElement</td> <td>DiagnosticInfo</td> </tr>
-<tr> <td>Int64</td> <td>NodeId</td> <td> </td> </tr>
-<tr> <td>UInt64</td> <td>ExpandedNodeId</td> <td> </td> </tr>
-</table>
-
-The builtin datatypes are combined into more complex structures. When the structure contains an array,
-then the size of the array is stored in an Int32 value just before the array itself. A size of -1
-indicates an undefined array. Positive sizes (and zero) have the usual semantics.
-
-Most importantly, every service has a request and a response message defined as such a data
-structure. The entire OPC UA protocol revolves around the exchange of these request and response
-messages. Their exact definitions can be looked up here:
-https://opcfoundation.org/UA/schemas/Opc.Ua.Types.bsd.xml. In open62541, we autogenerate the
-C-structs to handle the standard-defined structures automatically. See ua_types_generated.h for
-comparison.
-
-*/

doc/style/footer.html

@@ -1,20 +0,0 @@
-<!-- start footer part -->
-<!--BEGIN GENERATE_TREEVIEW-->
-<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
-  <ul>
-    $navpath
-    <li class="footer">$generatedby
-    <a href="http://www.doxygen.org/index.html">
-    <img class="footer" src="doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
-  </ul>
-</div>
-<!--END GENERATE_TREEVIEW-->
-<!--BEGIN !GENERATE_TREEVIEW-->
-<address class="footer"><small>
-$generatedby &#160;<a href="http://www.doxygen.org/index.html">
-<img class="footer" src="doxygen.png" alt="doxygen"/>
-</a> $doxygenversion
-</small></address>
-<!--END !GENERATE_TREEVIEW-->
-</body>
-</html>

doc/style/header.html

@@ -1,19 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
-<meta http-equiv="X-UA-Compatible" content="IE=9"/>
-<meta name="generator" content="Doxygen $doxygenversion"/>
-<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
-<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
-<script type="text/javascript" src="jquery-1.11.1.min.js"></script>
-<script type="text/javascript" src="dynsections.js"></script>
-<script type="text/javascript" src="load-style.js"></script>
-$treeview
-$search
-$mathjax
-<link href="doxygen.css" rel="stylesheet" type="text/css" />
-</head>
-<body>
-<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
-

doc/style/load-style.js

@@ -1,58 +0,0 @@
-$( document ).ready(function() {
-
-	$('#top > div > ul > li > a').wrapInner("<b></b>");
-
-	$("div.header").prepend("<h2></h2>");
-	$("div.header > h2").text($("div.title").text());
-	$("div.headertitle").remove();
-	$("#nav-path").remove();
-	
-	$("body").wrapInner("<div class='container'><div class='row'><div class='col-md-12'></div></div></div>");
-	$("ul.tablist").addClass("nav nav-pills nav-justified");
-	$("ul.tablist").css("margin-top", "0.5em");
-	$("ul.tablist").css("margin-bottom", "0.5em");
-	$("li.current").addClass("active");
-	$(".contents").wrapInner("<div class='panel panel-default' style='margin-top:1em;'><div class='panel-body'></div></div>");
-	$(".contents").find("h2.groupheader:first").remove();
-
-	$("iframe").attr("scrolling", "yes");
-	
-	$('img[src="ftv2ns.png"]').replaceWith('<span class="label label-danger">N</span> ');
-	$('img[src="ftv2cl.png"]').replaceWith('<span class="label label-danger">C</span> ');
-
-	// dirty workaround since doxygen 1.7 doesn't set table ids
-	$("table").each(function() {
-		if($(this).find("tbody > tr > td.indexkey").length > 0) {
-			$(this).addClass("table table-striped");
-		}
-	});
-	
-	$("table.params").addClass("table");
-	$("div.ingroups").wrapInner("<small></small>");
-	$("div.levels").css("margin", "0.5em");
-	$("div.levels > span").addClass("btn btn-default btn-xs");
-	$("div.levels > span").css("margin-right", "0.25em");
-	
-	$("table.directory").addClass("table table-striped");
-	$("div.summary > a").addClass("btn btn-default btn-xs");
-	$("table.fieldtable").addClass("table");
-	$(".fragment").addClass("well");
-	$(".memitem").addClass("panel panel-default");
-	$(".memproto").addClass("panel-heading");
-	$(".memdoc").addClass("panel-body");
-	$("span.mlabel").addClass("label label-info");
-	
-	$("table.memberdecls").addClass("table");
-	$("[class^=memitem]").addClass("active");
-	$("td.memSeparator").remove()
-	
-	$("div.ah").addClass("btn btn-default");
-	$("span.mlabels").addClass("pull-right");
-	$("table.mlabels").css("width", "100%")
-	$("td.mlabels-right").addClass("pull-right");
-
-	$("div.ttc").addClass("panel panel-info");
-	$("div.ttname").addClass("panel-heading");
-	$("div.ttdef,div.ttdoc,div.ttdeci").addClass("panel-body");
-});
-