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] | [List Home]

Subject: Documenting a XML-RPC API with Docbook?

[Sorry for the cross-posting but it is really an issue for both

I'm currently documenting the API of a XML-RPC
(http://www.xmlrpc.com/) server in Docbok and I wonder if there is One
True Way to do it?

Docbook markup for functions seems quite C-oriented and I was thinking
about the best mapping.

For instance, if I have a XML-RPC procedure defined as:

string domain.delete(name string, credentials struct)

I currently use:

    <paramdef><parameter>name</parameter> string</paramdef>
    <paramdef><parameter>credentials</parameter> string</paramdef>

Does it seem correct? (Let's not talk about the rendering yet, I'll
ask on docbook-apps.)

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