Re: Man page titles
"Alastair D'Silva" <[email protected]> Tue, 25 Jul 2017 10:39:15 +1000
| Newsgroups | gmane.text.doxygen.devel |
|---|---|
| Organization | IBM Australia |
| Message-ID | <[email protected]> |
--===============2058751883261770943==
Content-Type: multipart/alternative; boundary="=-R+kpMnZCCt9nW514d75s"
--=-R+kpMnZCCt9nW514d75s
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 7bit
On Mon, 2017-07-24 at 17:01 +1000, Alastair D'Silva wrote:
> Hi folks,
>
> I'm looking at using Doxygen for generating man pages for an open
> source API project we will be publishing, but have hit a small
> roadblock.
>
> When generating man pages, the page is titled with the name of the
> source file the definitions were defined in:
>
> src/afu.c(3) Library Functions Manual src/afu.c(3)
>
> NAME
> src/afu.c
>
> SYNOPSIS
> Functions
> ...
>
>
> I would like to override this to provide a more useful description to
> the user, such as "OpenCAPI AFU operations".
>
> Looking at ManGenerator::endTitleHead, it seems this format is
> hardcoded. I'm happy to post a patch, but would like some advice as
> to
> what command should be used to override the title for the current
> file.
>
> Cheers,
>
Scratch that, I was able to name the man page as I wanted by using:/** * @defgroup ocxl_afu OpenCAPI AFU operations * @{ */
--
Alastair D'Silva
Open Source Developer
Linux Technology Centre, IBM Australia
mob: 0423 762 819
--=-R+kpMnZCCt9nW514d75s
Content-Type: text/html; charset="utf-8"
Content-Transfer-Encoding: 7bit
<html><head></head><body><div><span><pre><pre>Scratch that, I was able to name the man page as I wanted by using:</pre><pre>/**</pre><pre> * @defgroup ocxl_afu OpenCAPI AFU operations</pre><pre> * @{</pre><pre> */</pre><pre><br></pre><pre>-- <br></pre>Alastair D'Silva
Open Source Developer
Linux Technology Centre, IBM Australia
mob: 0423 762 819</pre></span></div><div><br></div><div>On Mon, 2017-07-24 at 17:01 +1000, Alastair D'Silva wrote:</div><blockquote type="cite" style="margin:0 0 0 .8ex; border-left:2px #729fcf solid;padding-left:1ex"><pre>Hi folks,
I'm looking at using Doxygen for generating man pages for an open
source API project we will be publishing, but have hit a small
roadblock.
When generating man pages, the page is titled with the name of the
source file the definitions were defined in:
src/afu.c(3) Library Functions Manual src/afu.c(3)
NAME
src/afu.c
SYNOPSIS
Functions
...
I would like to override this to provide a more useful description to
the user, such as "OpenCAPI AFU operations".
Looking at ManGenerator::endTitleHead, it seems this format is
hardcoded. I'm happy to post a patch, but would like some advice as to
what command should be used to override the title for the current file.
Cheers,
</pre></blockquote><div><br></div></body></html>
--=-R+kpMnZCCt9nW514d75s--
--===============2058751883261770943==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline
------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
--===============2058751883261770943==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline
_______________________________________________
Doxygen-develop mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
--===============2058751883261770943==--