[jira] [Commented] (PROTON-462) Documentation: Add doxygen overview file for Proton C API

["Justin Ross (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/PROTON-462?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13826906#comment-13826906 ] 

Justin Ross commented on PROTON-462:
------------------------------------

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

> Documentation: Add doxygen overview file for Proton C API
> ---------------------------------------------------------
>
>                 Key: PROTON-462
>                 URL: https://issues.apache.org/jira/browse/PROTON-462
>             Project: Qpid Proton
>          Issue Type: Bug
>          Components: proton-c
>    Affects Versions: 0.5
>            Reporter: Ken Giusti
>             Fix For: 0.6
>
>
> 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.



--
This message was sent by Atlassian JIRA
(v6.1#6144)