NO-JIRA: [cpp] Minor API doc cleanup - Remove API doc references to non-existent page "endpoint_lifecycle" - Put extra doc pages in sensible order using pages.dox
Project: http://git-wip-us.apache.org/repos/asf/qpid-proton/repo Commit: http://git-wip-us.apache.org/repos/asf/qpid-proton/commit/d8a83eb6 Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/d8a83eb6 Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/d8a83eb6 Branch: refs/heads/master Commit: d8a83eb67d9d3178a6cca23ff76ae1bcb4f1ddf9 Parents: ded03b1 Author: Alan Conway <acon...@redhat.com> Authored: Tue Oct 30 15:08:50 2018 -0400 Committer: Alan Conway <acon...@redhat.com> Committed: Tue Oct 30 16:37:01 2018 -0400 ---------------------------------------------------------------------- cpp/docs/pages.dox | 9 +++++++++ cpp/docs/user.doxygen.in | 4 +++- cpp/include/proton/endpoint.hpp | 16 ++++++---------- cpp/include/proton/receiver.hpp | 2 -- cpp/include/proton/sender.hpp | 2 -- cpp/include/proton/session.hpp | 2 -- 6 files changed, 18 insertions(+), 17 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/d8a83eb6/cpp/docs/pages.dox ---------------------------------------------------------------------- diff --git a/cpp/docs/pages.dox b/cpp/docs/pages.dox new file mode 100644 index 0000000..c6471f5 --- /dev/null +++ b/cpp/docs/pages.dox @@ -0,0 +1,9 @@ +/// Order the pages in the documentations side-panel by declaring them here + +/// @page overview_page Overview +/// @page tutorial_page Tutorial +/// @page connect-config Connection Configuration +/// @page types_page AMQP and C++ types +/// @page mt_page Multi-threading +/// @page io_page IO integration +/// http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/d8a83eb6/cpp/docs/user.doxygen.in ---------------------------------------------------------------------- diff --git a/cpp/docs/user.doxygen.in b/cpp/docs/user.doxygen.in index 9810991..850adec 100644 --- a/cpp/docs/user.doxygen.in +++ b/cpp/docs/user.doxygen.in @@ -53,10 +53,12 @@ WARNINGS = YES # Configuration options related to the input files -INPUT = @CMAKE_SOURCE_DIR@/cpp/include \ +INPUT = @CMAKE_SOURCE_DIR@/cpp/docs/pages.dox \ @CMAKE_SOURCE_DIR@/cpp/docs \ + @CMAKE_SOURCE_DIR@/cpp/include \ @CMAKE_SOURCE_DIR@/cpp/examples \ @CMAKE_SOURCE_DIR@/docs/connect-config.md + FILE_PATTERNS = *.hpp *.md *.dox EXCLUDE_PATTERNS = @CMAKE_SOURCE_DIR@/cpp/examples/*.?pp \ @CMAKE_SOURCE_DIR@/cpp/include/proton/internal/*.hpp http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/d8a83eb6/cpp/include/proton/endpoint.hpp ---------------------------------------------------------------------- diff --git a/cpp/include/proton/endpoint.hpp b/cpp/include/proton/endpoint.hpp index 8fc3b27..50505ce 100644 --- a/cpp/include/proton/endpoint.hpp +++ b/cpp/include/proton/endpoint.hpp @@ -39,13 +39,13 @@ PN_CPP_CLASS_EXTERN endpoint { PN_CPP_EXTERN virtual ~endpoint(); // XXX Add the container accessor here. - + /// True if the local end is uninitialized. virtual bool uninitialized() const = 0; - + /// True if the local end is active. virtual bool active() const = 0; - + /// True if the local and remote ends are closed. virtual bool closed() const = 0; @@ -53,15 +53,11 @@ PN_CPP_CLASS_EXTERN endpoint { virtual class error_condition error() const = 0; // XXX Add virtual open() and open(endpoint_options) - + /// Close the endpoint. - /// - /// @see endpoint_lifecycle virtual void close() = 0; /// Close the endpoint with an error condition. - /// - /// @see endpoint_lifecycle virtual void close(const error_condition&) = 0; #if PN_CPP_HAS_DEFAULTED_FUNCTIONS && PN_CPP_HAS_DEFAULTED_MOVE_INITIALIZERS @@ -88,7 +84,7 @@ template <class T, class D> class iter_base { D operator++(int) { D x(*this); ++(*this); return x; } bool operator==(const iter_base<T, D>& x) const { return obj_ == x.obj_; } bool operator!=(const iter_base<T, D>& x) const { return obj_ != x.obj_; } - + protected: explicit iter_base(T p = 0) : obj_(p) {} T obj_; @@ -102,7 +98,7 @@ template<class I> class iter_range { I begin() const { return begin_; } I end() const { return end_; } bool empty() const { return begin_ == end_; } - + private: I begin_, end_; }; http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/d8a83eb6/cpp/include/proton/receiver.hpp ---------------------------------------------------------------------- diff --git a/cpp/include/proton/receiver.hpp b/cpp/include/proton/receiver.hpp index 7f78401..8643704 100644 --- a/cpp/include/proton/receiver.hpp +++ b/cpp/include/proton/receiver.hpp @@ -50,8 +50,6 @@ PN_CPP_CLASS_EXTERN receiver : public link { PN_CPP_EXTERN ~receiver(); /// Open the receiver. - /// - /// @see endpoint_lifecycle PN_CPP_EXTERN void open(); /// @copydoc open http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/d8a83eb6/cpp/include/proton/sender.hpp ---------------------------------------------------------------------- diff --git a/cpp/include/proton/sender.hpp b/cpp/include/proton/sender.hpp index 5f7c7b5..caf2f51 100644 --- a/cpp/include/proton/sender.hpp +++ b/cpp/include/proton/sender.hpp @@ -49,8 +49,6 @@ PN_CPP_CLASS_EXTERN sender : public link { PN_CPP_EXTERN ~sender(); /// Open the sender. - /// - /// @see endpoint_lifecycle PN_CPP_EXTERN void open(); /// @copydoc open http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/d8a83eb6/cpp/include/proton/session.hpp ---------------------------------------------------------------------- diff --git a/cpp/include/proton/session.hpp b/cpp/include/proton/session.hpp index 7f289f5..568c6d0 100644 --- a/cpp/include/proton/session.hpp +++ b/cpp/include/proton/session.hpp @@ -58,8 +58,6 @@ PN_CPP_CLASS_EXTERN session : public internal::object<pn_session_t>, public endp PN_CPP_EXTERN class error_condition error() const; /// Open the session. - /// - /// @see endpoint_lifecycle PN_CPP_EXTERN void open(); /// @copydoc open --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org