[haiku-doc] Re: Proposal: Page naming
- From: "Alan Smale" <ajsmale@xxxxxxxxx>
- To: haiku-doc@xxxxxxxxxxxxx
- Date: Wed, 30 May 2007 21:16:18 +0100
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 think this will make sure we have a clean namespace.
What do you think?
Niels
I'm having fun with this at the moment. Any ideas how to get a subsection
name to fit onto an 80 character line?
We may have difficulty sticking to this if we are limited to 80 chars as I
can't find a way to force Doxygen to allow multiple lines for naming
sections/subsections. Maybe I've missed something!
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 could abbreviate all the sections/pages but this would not be so readable.
Almost ready to submit my patch - just this one minor technicality to go!
Any ideas?
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.
Cheers
Alan
Other related posts:
