diff options
| author | Jeff Peeler <jpeeler@digium.com> | 2009-03-09 20:58:17 +0000 |
|---|---|---|
| committer | Jeff Peeler <jpeeler@digium.com> | 2009-03-09 20:58:17 +0000 |
| commit | bf0bb7b3859b7d24628c58f2ece35c89362094c1 (patch) | |
| tree | 5205beb525fe5b6e38f83e5efe910d8a7bf1cfdc /include/asterisk/http.h | |
| parent | dea550a29252aa6ef4f67f323d90eb29c3e8c794 (diff) | |
Add Doxygen documentation for API changes from 1.6.0 to 1.6.1
Copied from my review board description:
This is a continuation of the API changes documentation started for describing
changes between releases. Most of the API changes were pretty simple needing
only to be brought to attention via the new "Asterisk API Changes" list.
However, if you see anything that needs further explanation feel free to
supplement what is there. The current method of documenting is to add (in the
header file): \version <ver number> <description of changes> and then to add
the function to the change list in doxyref.h on the AstAPIChanges page. I also
made sure all the functions that were newly added were tagged with \since
1.6.1. I think this is a good habit to start both for the historical aspect as
well as for the future ability to easily add a "New Asterisk API" page.
Review: http://reviewboard.digium.com/r/190/
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@180719 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'include/asterisk/http.h')
| -rw-r--r-- | include/asterisk/http.h | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/include/asterisk/http.h b/include/asterisk/http.h index 218ac3f1a..25de13352 100644 --- a/include/asterisk/http.h +++ b/include/asterisk/http.h @@ -58,11 +58,11 @@ \note The method and the path as arguments and should return the content, allocated with malloc(). Status should be changed to reflect the status of the request if it isn't 200 and title may be set to a malloc()'d string - to an appropriate title for non-200 responses. Content length may also be specified. -\verbatim - The return value may include additional headers at the front and MUST include a blank + to an appropriate title for non-200 responses. Content length may also be specified. +\verbatim + The return value may include additional headers at the front and MUST include a blank line with \r\n to provide separation between user headers and content (even if no - content is specified) + content is specified) \endverbatim */ @@ -109,7 +109,12 @@ void ast_http_uri_unlink_all_with_key(const char *key); /*! \brief Return an ast_str malloc()'d string containing an HTTP error message */ struct ast_str *ast_http_error(int status, const char *title, const char *extra_header, const char *text); -/*! \brief Return the current prefix */ +/*! + * \brief Return the current prefix + * \param buf[out] destination buffer for previous + * \param len[in] length of prefix to copy + * \since 1.6.1 + */ void ast_http_prefix(char *buf, int len); #endif /* _ASTERISK_SRV_H */ |