Commit cadf5824 authored by Davis King's avatar Davis King

Updated htmlify manual.

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%403730
parent 80d44a99
...@@ -608,8 +608,15 @@ void print_manual ( ...@@ -608,8 +608,15 @@ void print_manual (
sout << "Htmlify also has the ability to create a simple index of all the files it is given. " sout << "Htmlify also has the ability to create a simple index of all the files it is given. "
<< "The --index option creates a file named index.html with a frame on the left side " << "The --index option creates a file named index.html with a frame on the left side "
<< "that contains links to all the files."; << "that contains links to all the files.";
cout << "\n\n" << wrap_string(sout.str(),indent,indent); sout.str("");
sout << "Finally, Htmlify can produce annotated XML output instead of HTML. The output will "
<< "contain all functions which are immediately followed by comments of the form /*! comment body !*/. "
<< "Similarly, all classes or structs that immediately contain one of these comments following their "
<< "opening { will also be output as annotated XML. Note also that if you wish to document a "
<< "piece of code using one of these comments but don't want it to appear in the output XML then "
<< "use either a comment like /* */ or /*!P !*/ to mark the code as \"private\".";
cout << "\n\n" << wrap_string(sout.str(),indent,indent) << "\n\n"; sout.str(""); cout << "\n\n" << wrap_string(sout.str(),indent,indent) << "\n\n"; sout.str("");
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment