[haiku-doc] Re: Proposal: Page naming
- From: "Niels Reedijk" <niels.reedijk@xxxxxxxxx>
- To: haiku-doc@xxxxxxxxxxxxx
- Date: Fri, 1 Jun 2007 09:31:43 +0200
Hi Alan,
2007/5/30, Alan Smale <ajsmale@xxxxxxxxx>:
On 25/05/07, Niels Reedijk <niels.reedijk@xxxxxxxxx> wrote:
[..snip..]
○ The page identifier should be the name of the page, without the
> underscore. So _drivers_fs_modules.dox will have the '\page
> drivers_fs_modules File System Modules' command in it.
> ○ Sections should start with the page name, and then add the
> appropriate section name on. So the introduction of that file should
> be '\section drivers_fs_modules_introduction'
> ○ Any further branches use the same technique: the name of the
> parent, an underscore and the name of the subsection.
I'm having fun with this at the moment. Any ideas how to get a subsection
name to fit onto an 80 character line?
No. \subsection commands are line commands anyway, Doxygen stops
parsing at the end of the line. Just do it on one line. They're
headings anyway.
My problem; I'm trying to declare a subsection with the following command:
\subsection
support_system_logging_syslog_usage_logging_sessions
Logging sessions
That is to say my page is "support_system_logging", my section is
"syslog_usage"and I want to write about "logging_sessions" as the
subsection. So I'm not trying to do anything elaborate.
This sticks to the conventions but is becoming too large to fit on a single
line. I've tried escaping the line using a '\' character, but no joy :-(
I see another problem, with readability, where both the section
separators and the names have underscores, it's hard to see where you
are. Could you check if you are allowed to use the dash (-) in unit
names, so: support_system-logging_logging-sessions?
I could abbreviate all the sections/pages but this would not be so readable.
Definately not.
Almost ready to submit my patch - just this one minor technicality to go!
Hurray!
BTW After emailing Axel he agreed to let me rework his original syslog
newsletter document. He's pleased we're working on it. What a top bloke.
Again: Hurray!
Good luck with these last remaining issues!
Niels
Other related posts:
