Re: DocBook function synopsis

Subject: Re: DocBook function synopsis
From: Norman Walsh <ndw@xxxxxxxxxx>
Date: Wed, 8 Jul 1998 08:12:11 -0400
/ "Frank A. Christoph" <christo@xxxxxxxxxxxxxxxxxx> was heard to say:
| No one replied to my question about C++ and Docbook, but I find it hard to
| believe that I am the only one who has ever run across this problem.  So I

Hi Frank,

Sorry I didn't reply sooner.  I've been meaning too.  The answer
is probably that there _is_ no good way to do it in a
FuncSynopsis at this time.  the FuncSynopsis content model was
designed to handle C functions, not C++ functions.

| just wanted to ask the same question one more time, and then I'll shut up
| and just modify the DTD myself.

I haven't had time to think about what I think the answer should
be, but if/when you modify the DTD, please share your
modifications.  Updating FuncSynopsis to handle a broader range
of programming languages seems like a good idea.

| How do you specify "declaration modifiers" like the "= 0" for pure virtual
| member functions, and the trailing "const" for member functions which don't
| modify the object state in a Docbook function synopsis?  For example,
| 
|   int foo(Bar *a, Jack *b, Jill *c) const = 0;
| 
| --FC
| 
| >How does one specify a C++ pure virtual method with DocBook's funcsynopsis
| >element?  I don't know where to put the "= 0" part...
| >
| ><funcsynopsis>
| ><funcprototype>
| ><funcdef>virtual Bar *<function>foo</function></funcdef>
| ><paramdef>const Jack *<parameter>arg1</parameter></paramdef>
| ><paramdef>const Jill *<parameter>arg2</parameter></paramdef>
| ></funcprototype>
| ></funcsynopsis>
| >
| >Judging from the content model, all I can think is to add near the end
| >
| ><funcsynopsisinfo>= 0</funcsynopsisinfo>
| >
| >but that certainly doesn't seem the right place (and besides, it doesn't
| >format correctly).
| 
|  DSSSList info and archive:  http://www.mulberrytech.com/dsssl/dssslist


 DSSSList info and archive:  http://www.mulberrytech.com/dsssl/dssslist


Current Thread
  • DocBook function synopsis
    • Frank A. Christoph - from mail1.ability.netby web4-1.ability.net (8.8.5/8.6.12) with ESMTP id WAA18410Sun, 5 Jul 1998 22:55:30 -0400 (EDT)
      • <Possible follow-ups>
      • Frank A. Christoph - from mail1.ability.netby web4-1.ability.net (8.8.5/8.6.12) with ESMTP id XAA29146Tue, 7 Jul 1998 23:13:17 -0400 (EDT)
        • Norman Walsh - from mail1.ability.netby web4-1.ability.net (8.8.5/8.6.12) with ESMTP id IAA12156Wed, 8 Jul 1998 08:15:53 -0400 (EDT) <=
      • Frank A. Christoph - from mail1.ability.netby web4-1.ability.net (8.8.5/8.6.12) with ESMTP id XAA11708Wed, 8 Jul 1998 23:33:04 -0400 (EDT)
        • Lionel Mallet - from mail1.ability.netby web4-1.ability.net (8.8.5/8.6.12) with ESMTP id DAA16760Thu, 9 Jul 1998 03:02:38 -0400 (EDT)
        • Mitch C. Amiano - from mail1.ability.netby web4-1.ability.net (8.8.5/8.6.12) with ESMTP id RAA02041Thu, 9 Jul 1998 17:03:33 -0400 (EDT)
      • Frank A. Christoph - from mail1.ability.netby web4-1.ability.net (8.8.5/8.6.12) with ESMTP id DAA20422Thu, 9 Jul 1998 03:45:12 -0400 (EDT)