OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

docbook message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]


Subject: DOCBOOK: Re: How are RFEs handled?


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

/ Jeff Biss <jeff@marco-inc.com> was heard to say:
| What you suggest would work. My only concern is that the API we are
| documenting is in C or C++ so function is apropos versus Java where
| method is. I am an electrical engineer who does technical writing for
| the project (and for my girlfriend's compnay) and has taught myself
| programming so my strengths are not in programming jargon. I defer to
| those who do understand the jargon better than I.

Well, that's a good argument for not using methodsynopsis then. They
really are functions not methods.

| As I see it I need a C and C++ element that can handle the access
| specifier (which could be rolled into the funcdef element) and the
| function keyword, without generating an error. As long as there is
| something that can do that, and do it obviously, I will be happy.

I still prefer <modifier>. It's consistent with the other elements, it
doesn't require adding new inlines to DocBook, and it is general
enough to handle not only the access specifier and the keyword, but
other modifiers that may be used by other people.

                                        Be seeing you,
                                          norm

P.S. The TC didn't meet yesterday as planned due to failure on my part
to manage my schedule as effectively as I expected to. I'm hoping to
reschedule soon and get this RFE dealt with for you.

- -- 
Norman Walsh <ndw@nwalsh.com>      | Endurance is frequently a form of
http://www.oasis-open.org/docbook/ | indecision.--Elizabeth Bibesco
Chair, DocBook Technical Committee |
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.6 (GNU/Linux)
Comment: Processed by Mailcrypt 3.5.7 <http://mailcrypt.sourceforge.net/>

iD8DBQE+LpYpOyltUcwYWjsRAjzwAJ4qfUezQvPwuVGjNOJEv3naJgnRKwCdE3tv
3l4dmlREG7p3UgmkVY8LI6A=
=cun6
-----END PGP SIGNATURE-----


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]


Powered by eList eXpress LLC