[Boost-docs] How to use the function tag?

Subject: [Boost-docs] How to use the function tag?
From: Eric Böse-Wolf (eric_at_[hidden])
Date: 2009-12-17 23:20:01


Hi All!
I try to document a small code snippet and wanted to do it "right"
(tm). If I try to process the following document with the boostbook ->
docbook xsl stylesheet, the function tag is spit out unchanged.
Later on the docbook -> html stylesheet complains about not knowing the
template and paramtype tags and so on. How can I do it correctly?

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
  "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<library name="Any" dirname="any" xmlns:xi="http://www.w3.org/2001/XInclude"
  id="any" last-revision="$Date: 2008-07-12 20:30:45 +0100 (Sat, 12 Jul 2008) $">
  <libraryinfo>
    <author>
      <firstname>Kevlin</firstname>
      <surname>Henney</surname>
    </author>
    <librarypurpose>
      Safe, generic container for single values of different value types
    </librarypurpose>
    <librarycategory name="category:data-structures"/>
  </libraryinfo>
  <function name="transitive_reduction_and_closure_for_dag">
    <template>
      <template-type-parameter name="Graph" />
      <template-type-parameter name="GraphTR" />
      <template-type-parameter name="G_to_TR_VertexMap" />
      <template-type-parameter name="GraphTC" />
      <template-type-parameter name="G_to_TC_VertexMap" />
      <template-type-parameter name="VertexIndexMap" />
    </template>
    <type>void</type>
    <parameter name="g">
      <paramtype>const Graph &amp;</paramtype>
    </parameter>
    <parameter name="tr">
      <paramtype>GraphTR &amp;</paramtype>
    </parameter>
    <parameter name="g_to_tr_map">
      <paramtype>G_to_TR_VertexMap</paramtype>
    </parameter>
    <parameter name="tc">
      <paramtype>GraphTC &amp;</paramtype>
    </parameter>
    <parameter name="g_to_tc_map">
      <paramtype>G_to_TC_VertexMap</paramtype>
    </parameter>
    <parameter name="index_map">
      <paramtype>VertexIndexMap</paramtype>
    </parameter>
  </function>
</library>


This archive was generated by hypermail 2.1.7 : 2017-11-11 08:50:41 UTC