[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]
Subject: DOCBOOK: Re: methodsynopsisinfo tag?
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 / Alex Russell <alex@netwindows.org> was heard to say: | On Monday 17 February 2003 06:41 pm, Norman Walsh wrote: |> / Alex Russell <alex@netwindows.org> was heard to say: |> [...] |> |> Have you considered simply moving the methodsynopsis out of the |> classsynopsis, at least for the purposes of larger description? | | I'd considered it, but it seems a bit cumbersome and doesn't "feel right" to | me, espically given the presence of a functionsynopsisinfo tag which | essentially fills my needs. It seems kind of inconsistent not to include a | similar descriptive capability for a callable entry point simply because it | has the context of a class and not the top-level namespace.. Alas, funcsynopsisinfo doesn't fulfill the need you have. Consider this example: <!DOCTYPE funcsynopsis PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"> <funcsynopsis> <funcsynopsisinfo> #include <varargs.h> </funcsynopsisinfo> <funcprototype> <funcdef>int <function>max</function></funcdef> <varargs/> </funcprototype> </funcsynopsis> The funcsynopsisinfo element is really just a special "verbatim" container. Yes, it's poorly named. |> You could even make the methodsynopsis a link back to some |> classsynopsis overview at the top of the document, with a little |> effort. | | I think for now that's what we'll do, although I still consider the lack of | a methodsynopsisinfo tag to be an omission (if only for the sake of | consistency). The idea is that you don't need that special sort of verbatim capability at the level of each method signature. Be seeing you, norm - -- Norman Walsh <ndw@nwalsh.com> | Never interrupt your enemy when he http://www.oasis-open.org/docbook/ | is making a mistake.--Napoleon 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+UjQmOyltUcwYWjsRAg6iAJ9rwD0p6t9+7pe6KxJfbRNQXwAC4ACfYvp1 Vfnq3vBKKvx4pqPVLXXLyQM= =dho5 -----END PGP SIGNATURE-----
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [Elist Home]
Powered by eList eXpress LLC