Qpid Proton
  1. Qpid Proton
  2. PROTON-462

Documentation: Add doxygen overview file for Proton C API

    Details

    • Type: Bug Bug
    • Status: Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: 0.5
    • Fix Version/s: 0.9
    • Component/s: proton-c
    • Labels:
      None

      Description

      If possible, have the web page link to the public header files as the start page - that's were the meat of the API documentation exists.

        Activity

        Hide
        Justin Ross added a comment -

        I suggest that we have a little introductory text in the overview, including the following info:

        • Proton contains two APIs, the protocol engine and messenger
        • The important (entry point) APIs for the protocol engine are $here
        • The entry point for messenger is $here
        Show
        Justin Ross added a comment - I suggest that we have a little introductory text in the overview, including the following info: Proton contains two APIs, the protocol engine and messenger The important (entry point) APIs for the protocol engine are $here The entry point for messenger is $here
        Hide
        Justin Ross added a comment -
        Show
        Justin Ross added a comment - For reference, the C++ doxygen overview: https://svn.apache.org/repos/asf/qpid/trunk/qpid/cpp/docs/api/doxygen_mainpage.h

          People

          • Assignee:
            Rafael H. Schloming
            Reporter:
            Ken Giusti
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:

              Development