41 Commits

Author SHA1 Message Date
Andrey Semashev
d108e4d24a Disable function parameter sorting by default.
Sorted parameters are more difficult to read, as you normally expect
the parameters to be described in the order they are listed in the
function signature. This also breaks parameter grouping when adjacent
parameters are related (e.g. a pair of iterators).
2024-07-01 02:36:18 +03:00
Andrey Semashev
61ca6ef7d9 Fix missing members and functions in named groups in Doxygen output.
Previously, class members and free functions in sectiondef with
kind="user-defined" would be stripped from HTML output, making function
grouping effectively non-functional. This commit fixes this by converting
such sectiondefs to either method-group or free-function-group in BoostBook
output, depending on whether the grouping is within a class or namespace.

Additionally, previously constructors, destructors and assignment operators
were not allowed to be inside method-groups, which were another reason for
these members to be stripped from the output. This commit allows these members
in member-groups and modifies DTD accordingly.

Also, this fixes duplicate constructors, destructors and assignment operators
generated after the sections for public, private and protected member
functions. This was due to applying XSL templates twice - once when generating
method-group, and then after the method-group.
2024-05-13 15:55:20 +03:00
Andrey Semashev
44d887c5f2 Support disabling sorting function and template parameters.
This commit adds a new XSL parameter boost.sort.params, which allows
users to disable alphabetical sorting of the function and template
parameters in detailed descriptions of functions and classes. By
default, sorting is enabled, which maintains the previous behavior.

Sorting is disabled when the parameter is set to 0. In this case,
parameters are listed in the order they are listed in the BoostBook
documentation, which is normally the same as they are listed in the
function signature or template preamble.
2024-05-13 03:45:32 +03:00
Daniel James
5c02634c70 Revert change to function.
Will implement using language attribute instead.

[SVN r86508]
2013-10-28 22:34:35 +00:00
Daniel James
248ccf3ca4 Use syntax highlighting for function reference.
This appears to have removed the computeroutput tags from function links in
the hash documentation. I'm not sure if the solution is to retain them in
annotation mode or to be smarted about syntax highlighting programlisting.

[SVN r86505]
2013-10-28 20:15:14 +00:00
Steven Watanabe
3d2c61d79b Better handling of tparam.
[SVN r74982]
2011-10-16 17:32:17 +00:00
Steven Watanabe
153b3e63b4 make sure that default arguments for parameters that start a new line are highlighted.
[SVN r63364]
2010-06-26 17:23:54 +00:00
Steven Watanabe
bb67cd7547 Fix markup problems reported by Eric Niebler.
[SVN r62894]
2010-06-13 03:08:36 +00:00
Steven Watanabe
f3e0f03654 Make sure that every bit of C++ code that we output goes through the syntax highlighter
[SVN r62294]
2010-05-28 14:40:48 +00:00
Daniel James
5220fa791b Display text purposes in function reference.
[SVN r51647]
2009-03-08 09:45:51 +00:00
Daniel James
aa95798fbe Add link to the header to the synopsis in reference documentation.
Refs #2214

[SVN r49669]
2008-11-09 21:57:38 +00:00
Daniel James
843e939404 Support for variadic parameters.
Merged revisions 44832-44957,44959-44995,44997-45128,45132-45135 via svnmerge from 
https://svn.boost.org/svn/boost/branches/doc

........
  r44832 | danieljames | 2008-04-28 07:55:01 +0100 (Mon, 28 Apr 2008) | 2 lines
  
  Add variadic attribute to template type parameters.
........
  r44943 | danieljames | 2008-04-30 20:27:32 +0100 (Wed, 30 Apr 2008) | 1 line
  
  Back out my half-done support for variadic template parameters.
........
  r44994 | danieljames | 2008-05-01 21:52:59 +0100 (Thu, 01 May 2008) | 1 line
  
  Support for variadic template parameters.
........
  r45132 | danieljames | 2008-05-05 12:37:35 +0100 (Mon, 05 May 2008) | 2 lines
  
  Rename variadic attributes pack.
........
  r45133 | danieljames | 2008-05-05 12:37:50 +0100 (Mon, 05 May 2008) | 2 lines
  
  Support for function parameter packs.
........
  r45134 | danieljames | 2008-05-05 12:38:08 +0100 (Mon, 05 May 2008) | 2 lines
  
  Support for inherited pack expansions.
........
  r45135 | danieljames | 2008-05-05 12:38:25 +0100 (Mon, 05 May 2008) | 2 lines
  
  Support for pack expansions in template specializations.
........


[SVN r45741]
2008-05-25 16:14:17 +00:00
Frank Mori Hess
abc4097abf Fixed spurious paragraph in html output for overloaded
methods.



[SVN r40702]
2007-11-02 22:37:52 +00:00
Frank Mori Hess
677773ea5b Added support for new boostbook <access> element for documenting non-public
class members.

function.xsl, type.xsl, utility.xsl: Added support for <access> elements to
allow nonpublic access specifiers for class member documentation.

boostbook.dtd: Updated to reflect new <access> element.  Updated Peter Simons
email address.  Added mention of boost license.

reference.dtdxml: Added reference documentation for new <access> element.
Removed some obsolete remarks from the description of inherit element.

reference.xml: The changes to this file were generated by applying
dtd2boostbook.xsl to the updated reference.dtdxml file.



[SVN r40555]
2007-10-29 15:18:49 +00:00
Rene Rivera
3c43a8045c Fix minor validation problem with boostbook.
[SVN r36044]
2006-11-15 17:46:40 +00:00
Rene Rivera
835e482af7 Cross merge HEAD and RC_1_34_0.
[SVN r36024]
2006-11-13 16:24:38 +00:00
Douglas Gregor
c6499c1345 Unnamed parameter fix, from Julio M. Merino Vidal
[SVN r34797]
2006-08-01 14:00:22 +00:00
Eric Niebler
94f520b924 use fixed-width font for parameter names in doxygen-generated parameter lists
[SVN r33483]
2006-03-27 04:31:12 +00:00
Eric Niebler
0f83dbdf6f improve layout for Doxygen-generated function documentation
[SVN r33445]
2006-03-22 18:46:39 +00:00
Douglas Gregor
24621811da Some cosmetic tweaks to get rid of empty synopses, empty function groups, and use more nested directories
[SVN r33018]
2006-02-20 03:09:03 +00:00
Douglas Gregor
60c318f225 Move function parameter documentation after the description
[SVN r24673]
2004-08-23 15:21:35 +00:00
Douglas Gregor
aece427f54 Deal with parameter documentation in overloaded functions
[SVN r23387]
2004-07-07 04:19:11 +00:00
Douglas Gregor
9ea136fecd docbook.xsl, function.xsl, macro.xsl, type.xsl:
- Allow BoostBook markup in <purpose>


[SVN r23330]
2004-07-03 22:20:11 +00:00
Douglas Gregor
91c19f9b91 function.xsl: Fix problem with ungrouped methods
[SVN r21065]
2003-12-02 06:08:29 +00:00
Douglas Gregor
02fd5d3611 function.xsl: Default values can not be annotated
doxygen/doxygen2boostbook.xsl: If the string "detail::" is found in a
type or default argument, the type/argument is replaced with
"unspecified".


[SVN r20810]
2003-11-15 05:36:47 +00:00
Douglas Gregor
075fcc3cbd doxygen/doxygen2boostbook.xsl: Don't strip <para> elements from within
(generated) <purpose> elements; just make them <simpara> elements.

annotation.xsl: Added a "purpose" mode that strips paragraph elements
for printing the purpose in a comment

function.xsl: Don't compact methods or overloaded methods.


[SVN r20499]
2003-10-27 01:13:34 +00:00
Douglas Gregor
c1cdd4526f Put some extra spacing before function synopsis that have a comment.
[SVN r20498]
2003-10-26 23:40:18 +00:00
Douglas Gregor
5bbddee283 Strip <para> and <simpara> elements when printing the purpose of a
function into the synopsis (because it has no detailed documentation).


[SVN r20497]
2003-10-26 23:35:29 +00:00
Douglas Gregor
e9232f91cc Fix missing return type for copy assignment operators
[SVN r20103]
2003-09-18 19:59:48 +00:00
Douglas Gregor
ebb5873362 - Highlight the function name when printing it, so "operator" gets
highlighted for overloaded operators


[SVN r20098]
2003-09-18 18:43:12 +00:00
Douglas Gregor
ae2938aa76 function.xsl: Do proper highlighting/linking for the return types of
functions


[SVN r20096]
2003-09-18 18:38:51 +00:00
Douglas Gregor
a6666cd27a function.xsl:
- Don't link entire function declaration; just link the name.


[SVN r19842]
2003-08-28 21:43:09 +00:00
Douglas Gregor
1689acb635 - use generate.id instead of generate-id
- Add the "-bb" suffix to id names generated by generate-id


[SVN r19756]
2003-08-23 15:54:46 +00:00
Douglas Gregor
d1ab30b7f1 Don't highlight a full declaration if the template header was placed on a
separate line.


[SVN r19061]
2003-07-11 16:09:47 +00:00
Douglas Gregor
bfa67ad183 dtd/boostbook.dtd:
- Parameters can now have <description> elements
	- Add function specifiers

xsl/function.xsl:
	- When needed, place function return type on a separate line
	- Format <description> element for parameters
	- Use "spacing=boost" for variablelists used for function requirements

xsl/doxygen/doxygen2boostbook.xsl:
	- Emit <description> elements for parameters when available
	- Properly translate file descriptions


[SVN r18963]
2003-07-07 15:31:34 +00:00
Douglas Gregor
2f878b7612 function.xsl:
- Use arabic numbering for semantic clauses

collect.xsl:
  - Accept the input directory as a stylesheet parameter

doxygen2boostbook.xsl:
  - Update for recent changes in the BoostBook XML format


[SVN r18242]
2003-04-13 14:44:38 +00:00
Douglas Gregor
ce3af72b76 function.xsl: Remove the <formalpara> stuff from the 'standardese' generation
mode. It looks silly at the moment.


[SVN r18184]
2003-04-04 21:37:30 +00:00
Douglas Gregor
9c4a80af08 function.xsl, template.xsl, type.xsl:
- Deal with changes in the DTD

html.xsl, html-single.xsl:
  - Better handling of function semantic clauses


[SVN r17940]
2003-03-15 23:11:32 +00:00
Douglas Gregor
d2e78d320f Use description element in functions
[SVN r17935]
2003-03-15 21:36:10 +00:00
Douglas Gregor
c9c1f578ca use the generate.id template, not generate-id
[SVN r17925]
2003-03-14 21:39:17 +00:00
Douglas Gregor
df433e64bd Imported BoostBook XSL stylesheets and DTD
[SVN r17862]
2003-03-12 22:01:44 +00:00