ReleaseNotes.html   [plain text]

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
	<title>HeaderDoc Release Notes</title>
	<meta name="generator" content="BBEdit 6.5.2">
<a href="HeaderDoc.html">[Overview]</a>
<h1>Release Notes</h1>
<address>Author: Matt Morse (</address>
<address>Last modified: 09/14/2002</address>
<h2>HeaderDoc 7.2</h2>
The intent of this release is to fix several long-standing bugs. The numbers in parentheses refer to bug numbers in Apple's internal bug tracking database.

<h3>Bugs fixed</h3>

	<dt><b>More flexible handling of colons</dt></b>
		<dd>HeaderDoc was confused by spaces around the C++ access control modifiers public:, private:, and protected:. Submitted by Stephane Sudre(2472454)</dd>

	<dt><b>HeaderDoc should handle var args in function declaration</dt></b>
		<dd>If you specify a parameter as a variable argument list by using '...', HeaderDoc ignores that parameter and its description in the HTML output.  (2551202)</dd>
	<dt><b>Fix for invalid HTML</dt></b>
		<dd>The HTML for some tables was faulty, with the closing element being &lt;tr&gt; rather than &lt;/tr&gt;.  This submission also removed the space characters around the equals sign in HTML attribute/value pairs, so that 'name = "Foo"' is now 'name="Foo"'. Either is valid HTML.  Fix submitted by Jonatan Lander. (2832476)</dd>

	<dt><b>Extra (); after some typedefs</dt></b>
		<dd>HeaderDoc was adding parens after the declaration of some simple typedefs, like <tt>typedef int FooInt;</tt> (2845591)</dd>
	<dt><b>HeaderDoc2HTML: @enum does not allow more than one word after it.</dt></b>
		<dd>HeaderDoc comments with @enum declarations like:  <tt>@enum Beverage Categories</tt> were losing one of the words of the name. (2905256)</dd>
	<dt><b>Improve formatting for function declarations</dt></b>
		<dd>The full information for each parameter is now displayed on its own line. (2982025)</dd>

	<dt><b>Enumerations missing from printable page version of output</dt></b>
		<dd>They appeared properly in the Constants.html page, but weren't included in the CompositePage.html page. (3017250)</dd>

	<dt><b>HeaderDoc not adding apple_refs to ObjC class names</dt></b>
		<dd>HeaderDoc correctly adds "apple_ref" markup to class and instance methods, but not to the class name itself.  This prevents Project Builder or other documentation indexers from finding these introductory pages. (See <a href="APIAnchors.html">APIAnchors.html</a> in the HeaderDoc documentation for more information about apple_ref markup.) (3042788)</dd>

	<dt><b>HeaderDoc generating duplicate API markers</dt></b>
		<dd>HeaderDoc adds "apple_ref" markup to every documented API symbol (see <a href="APIAnchors.html">APIAnchors.html</a> in the HeaderDoc documentation for more information). These markers must be unique so that Project Builder and other documentation indexers have one place to send readers for information.  Because of the way the printable page (CompositePage.html) was derived from the standard documentation, the apple_refs were appearing twice, once in the primary page (say, Functions.html) and once in the composite page.  Now, HeaderDoc prevents this markup from appearing in the composite page. (3050022)</dd>
	<dt><b>HeaderDoc should add the 'generator' meta tag to HTML output</dt></b>
		<dd>The element  &lt;meta name="generator" content="HeaderDoc"&gt; is now added to all HTML pages. (2824759)    </dd>
<h3>New Feature</h3>
	<dt><b>Command line switch to make HeaderDoc run silently</dt></b>
		<dd>The -q flag on the HeaderDoc command line makes HeaderDoc run silently.  Feature was submitted by Ryan Wilcox (2817440).</dd>

Added more test cases to the ExampleHeaders folder.  Added DOCTYPE declarations to top of HTML pages.