From ce96d1b153447850667d8bb2e5e5cae8799494f0 Mon Sep 17 00:00:00 2001 From: William S Fulton Date: Fri, 15 Sep 2017 07:58:32 +0100 Subject: [PATCH] Library docs chapter tweaks - Consistency in heading names - html fixes - shared_ptr corrections and add in subheadings --- Doc/Manual/Contents.html | 12 ++++++++--- Doc/Manual/Library.html | 45 ++++++++++++++++++++++------------------ 2 files changed, 34 insertions(+), 23 deletions(-) diff --git a/Doc/Manual/Contents.html b/Doc/Manual/Contents.html index 97db5f11c..f3beb2298 100644 --- a/Doc/Manual/Contents.html +++ b/Doc/Manual/Contents.html @@ -358,26 +358,32 @@
-

-%shared_ptr and Templates -

+

9.4.4.3 shared_ptr and templates

+

Only the single %shared_ptr declaration should be used for all specializations @@ -1931,25 +1934,27 @@ of the template before the first template instantiation using the following nota 

 %include <std_shared_ptr.i>
 
-%shared_ptr(Graph<>);  //!< Declaration of the transparent shared ptr for the Graph template
+%shared_ptr(Graph<>);  // Declaration of the transparent shared ptr for the Graph template
 
 %{
-  #include "graph.hpp"  // Graph definition (inside the namespace gany)
+  #include "graph.h"  // Graph definition (inside the namespace gany)
   using namespace gany;
 %}
 
 %include "graph.h"  // Graph declaration (inside the namespace gany)
 using namespace gany;
 
-%template(SGraph) Graph<false>;  //!< Simple graph 
+%template(SGraph) Graph<false>;  // Simple graph
 // Note: the Graph name is redefined in the following line from the template to the specialization (class)
-%template(Graph) Graph<true>;  //!< Weighted graph
+%template(WGraph) Graph<true>;  // Weighted graph
+

9.4.4.4 shared_ptr and directors

+

-Note: There is somewhat limited support for %shared_ptr and the director feature +There is somewhat limited support for %shared_ptr and the director feature and the degrees of success varies among the different target languages. Please help to improve this support by providing patches with improvements.