Changeset 44681


Ignore:
Timestamp:
Apr 21, 2008, 6:14:29 AM (10 years ago)
Author:
chris_kohlhoff
Message:

Ensure all non-friend related functions are included in the documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/libs/asio/doc/reference.xsl

    r43473 r44681  
    4646[include requirements/ConvertibleToMutableBuffer.qbk]
    4747[include requirements/DatagramSocketService.qbk]
     48[include requirements/DescriptorService.qbk]
    4849[include requirements/Endpoint.qbk]
    4950[include requirements/GettableSocketOption.qbk]
    5051[include requirements/Handler.qbk]
     52[include requirements/HandleService.qbk]
    5153[include requirements/InternetProtocol.qbk]
    5254[include requirements/IoControlCommand.qbk]
     
    6163[include requirements/SocketAcceptorService.qbk]
    6264[include requirements/SocketService.qbk]
     65[include requirements/StreamDescriptorService.qbk]
     66[include requirements/StreamHandleService.qbk]
    6367[include requirements/StreamSocketService.qbk]
    6468[include requirements/SyncReadStream.qbk]
     
    8690      </xsl:when>
    8791      <xsl:otherwise>
    88         <xsl:if test="not(contains(ancestor::*/compoundname, '::detail'))">
     92        <xsl:if test="
     93            not(contains(ancestor::*/compoundname, '::detail')) and
     94            not(contains(ancestor::*/compoundname, '_helper'))">
    8995          <xsl:call-template name="namespace-memberdef"/>
    9096        </xsl:if>
     
    190196        <xsl:with-param name="name"
    191197         select="concat(substring-before($name, '&gt;'), '_gt_', substring-after($name, '&gt;'))"/>
     198      </xsl:call-template>
     199    </xsl:when>
     200    <xsl:when test="contains($name, '+')">
     201      <xsl:call-template name="make-id">
     202        <xsl:with-param name="name"
     203         select="concat(substring-before($name, '+'), '_plus_', substring-after($name, '+'))"/>
    192204      </xsl:call-template>
    193205    </xsl:when>
     
    617629</xsl:if>
    618630
    619 <xsl:if test="count(sectiondef[@kind='friend']/memberdef[not(type = 'friend class')]) &gt; 0">
    620 [heading Friends]
     631<xsl:if test="count(sectiondef[@kind='protected-func' or @kind='protected-static-func']) > 0">
     632[heading Protected Member Functions]
    621633[table
    622634  [[Name][Description]]
    623 <xsl:for-each select="sectiondef[@kind='friend']/memberdef[not(type = 'friend class')]" mode="class-table">
     635<xsl:for-each select="sectiondef[@kind='protected-func' or @kind='protected-static-func']/memberdef" mode="class-table">
    624636  <xsl:sort select="name"/>
    625637  <xsl:variable name="name">
     
    666678]
    667679</xsl:if>
     680
     681<xsl:if test="count(sectiondef[@kind='protected-attrib' or @kind='protected-static-attrib']) > 0">
     682[heading Protected Data Members]
     683[table
     684  [[Name][Description]]
     685<xsl:for-each select="sectiondef[@kind='protected-attrib' or @kind='protected-static-attrib']/memberdef" mode="class-table">
     686  <xsl:sort select="name"/>
     687  [
     688    [[link boost_asio.reference.<xsl:value-of select="$class-id"/>.<xsl:value-of select="name"/>
     689      <xsl:text> </xsl:text>[*<xsl:value-of select="name"/>]]]
     690    [<xsl:value-of select="briefdescription"/>]
     691  ]
     692</xsl:for-each>
     693]
     694</xsl:if>
     695
     696<xsl:if test="count(sectiondef[@kind='friend']/memberdef[not(type = 'friend class') and not(contains(name, '_helper'))]) &gt; 0">
     697[heading Friends]
     698[table
     699  [[Name][Description]]
     700<xsl:for-each select="sectiondef[@kind='friend']/memberdef[not(type = 'friend class') and not(contains(name, '_helper'))]" mode="class-table">
     701  <xsl:sort select="name"/>
     702  <xsl:variable name="name">
     703    <xsl:value-of select="name"/>
     704  </xsl:variable>
     705  <xsl:variable name="id">
     706    <xsl:call-template name="make-id">
     707      <xsl:with-param name="name" select="$name"/>
     708    </xsl:call-template>
     709  </xsl:variable>
     710  <xsl:variable name="doxygen-id">
     711    <xsl:value-of select="@id"/>
     712  </xsl:variable>
     713  <xsl:variable name="overload-position">
     714    <xsl:for-each select="../memberdef[name = $name]">
     715      <xsl:if test="@id = $doxygen-id">
     716        <xsl:value-of select="position()"/>
     717      </xsl:if>
     718    </xsl:for-each>
     719  </xsl:variable>
     720  <xsl:if test="$overload-position = 1">
     721  [
     722    [[link boost_asio.reference.<xsl:value-of select="$class-id"/>.<xsl:value-of select="$id"/>
     723      <xsl:text> </xsl:text>[*<xsl:value-of select="$name"/>]]]
     724    [<xsl:value-of select="briefdescription"/>]
     725  ]
     726  </xsl:if>
     727</xsl:for-each>
     728]
     729</xsl:if>
     730
     731<xsl:if test="count(sectiondef[@kind='related']/memberdef) &gt; 0">
     732[heading Related Functions]
     733[table
     734  [[Name][Description]]
     735<xsl:for-each select="sectiondef[@kind='related']/memberdef" mode="class-table">
     736  <xsl:sort select="name"/>
     737  <xsl:variable name="name">
     738    <xsl:value-of select="name"/>
     739  </xsl:variable>
     740  <xsl:variable name="id">
     741    <xsl:call-template name="make-id">
     742      <xsl:with-param name="name" select="$name"/>
     743    </xsl:call-template>
     744  </xsl:variable>
     745  <xsl:variable name="doxygen-id">
     746    <xsl:value-of select="@id"/>
     747  </xsl:variable>
     748  <xsl:variable name="overload-position">
     749    <xsl:for-each select="../memberdef[name = $name]">
     750      <xsl:if test="@id = $doxygen-id">
     751        <xsl:value-of select="position()"/>
     752      </xsl:if>
     753    </xsl:for-each>
     754  </xsl:variable>
     755  <xsl:if test="$overload-position = 1">
     756  [
     757    [[link boost_asio.reference.<xsl:value-of select="$class-id"/>.<xsl:value-of select="$id"/>
     758      <xsl:text> </xsl:text>[*<xsl:value-of select="$name"/>]]]
     759    [<xsl:value-of select="briefdescription"/>]
     760  ]
     761  </xsl:if>
     762</xsl:for-each>
     763]
     764</xsl:if>
     765
    668766</xsl:template>
    669767
     
    672770<xsl:param name="class-name"/>
    673771<xsl:param name="class-id"/>
    674 <xsl:apply-templates select="sectiondef[@kind='public-type' or @kind='public-func' or @kind='public-static-func' or @kind='public-attrib' or @kind='public-static-attrib' or @kind='friend']/memberdef[not(type = 'friend class')]" mode="class-detail">
     772<xsl:apply-templates select="sectiondef[@kind='public-type' or @kind='public-func' or @kind='public-static-func' or @kind='public-attrib' or @kind='public-static-attrib' or @kind='protected-func' or @kind='protected-static-func' or @kind='protected-attrib' or @kind='protected-static-attrib' or @kind='friend' or @kind='related']/memberdef[not(type = 'friend class') and not(contains(name, '_helper'))]" mode="class-detail">
    675773  <xsl:sort select="name"/>
    676774  <xsl:with-param name="class-name" select="$class-name"/>
Note: See TracChangeset for help on using the changeset viewer.