Skip to contentSkip to conversation

Update doxygen (a bit)

PATCH In review Steffan Karger 2 participants 2 messages Dec 7, 2014

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Update doxygen (a bit)

This is not a full update, but just updates some data channel-related docs I came across. Other pages probably need a bit of attention too.

Stuff that was changed:
* Explain data channel crypto format in crypto.h
* Add P_DATA_V1 and P_DATA_V2 packet format spec
* Remove '2.1' from title
* Update some OpenSSL-specific text

---
 .gitignore                          |  1 +
 doc/doxygen/doc_data_crypto.h       |  4 +--
 doc/doxygen/doc_mainpage.h          |  2 +-
 doc/doxygen/doc_protocol_overview.h | 69 +++++++++++++++++------------------
 src/openvpn/crypto.h                | 72 ++++++++++++++++++++++++++++++++++++-
 5 files changed, 107 insertions(+), 41 deletions(-)
.gitignore +1 -0
index 538c020..06ff7c6 100644
@@ -33,6 +33,7 @@ config.sub
 configure
 configure.h
 depcomp
+doxygen/
 stamp-h1
 install-sh
 missing
doc/doxygen/doc_data_crypto.h +1 -3
index 8dcc15a..1172672 100644
@@ -69,7 +69,5 @@
  *
  * @par Crypto algorithms
  * This module uses the crypto algorithm implementations of the external
- * OpenSSL library.  More precisely, it uses the OpenSSL library's \c
- * EVP_Cipher* and \c HMAC_* set of functions to perform cryptographic
- * operations on data channel packets.
+ * crypto library (currently either OpenSSL (default), or PolarSSL).
  */
doc/doxygen/doc_mainpage.h +1 -1
index 821b2e8..ed8e324 100644
@@ -29,7 +29,7 @@
  */
 
 /**
- * @mainpage OpenVPN v2.1 source code documentation
+ * @mainpage OpenVPN source code documentation
  *
  * This documentation describes the internal structure of OpenVPN.  It was
  * automatically generated from specially formatted comment blocks in
doc/doxygen/doc_protocol_overview.h +33 -36

101 lines not on this page · raw message

src/openvpn/crypto.h +71 -1

84 lines not on this page · raw message

Signature · 1 line
1.9.1
#1 lore raw

ACK. Docs good :-)

Your patch has been applied to the master and release/2.3 branch.

commit b08c25dbaeffbdd80acc143a931a276163c851a3 (master) commit d6c5a6037f93c10baecbcde98e249ceb6f863683 (release/2.3)

Author: Steffan Karger
Date:   Sun Dec 7 19:48:15 2014 +0100
     Update doxygen (a bit)

     Signed-off-by: Steffan Karger <[email protected]...>
     Acked-by: Gert Doering <[email protected]...>
     Message-Id: <[email protected]...>
     URL: http://article.gmane.org/gmane.network.openvpn.devel/9318
     Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering