You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@milagro.apache.org by km...@apache.org on 2019/02/08 08:06:36 UTC

[incubator-milagro-crypto] 06/15: updated doxygen to include wcc

This is an automated email from the ASF dual-hosted git repository.

kmccusker pushed a commit to branch update-code
in repository https://gitbox.apache.org/repos/asf/incubator-milagro-crypto.git

commit b55e6130f835df16035f3394d5804c9954df2889
Author: Kealan McCusker <ke...@certivox.com>
AuthorDate: Thu Apr 28 09:15:10 2016 +0100

    updated doxygen to include wcc
---
 c/mpin.c         |  2 --
 c/wcc.c          | 11 ++++++++---
 c/wcc.h          | 11 +++++++++--
 docs/AMCL.dox    |  2 +-
 docs/Doxyfile.in |  1 +
 5 files changed, 19 insertions(+), 8 deletions(-)

diff --git a/c/mpin.c b/c/mpin.c
index a29dfe0..b494833 100755
--- a/c/mpin.c
+++ b/c/mpin.c
@@ -19,8 +19,6 @@ under the License.
 
 /* MPIN Functions */
 
-/* Version 3.0 - supports Time Permits */
-
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
diff --git a/c/wcc.c b/c/wcc.c
index 48c6392..c1c8a75 100755
--- a/c/wcc.c
+++ b/c/wcc.c
@@ -17,9 +17,14 @@ specific language governing permissions and limitations
 under the License.
 */
 
-/* Wang Functions */
-
-/* Version 3.0 - supports Time Permits */
+/**
+ * @file wcc.c
+ * @author Mike Scott and Kealan McCusker
+ * @date 28th April 2016
+ * @brief Wang / Chow Choo (WCC) definitions
+ *
+ *
+ */
 
 #include <stdio.h>
 #include <stdlib.h>
diff --git a/c/wcc.h b/c/wcc.h
index 1f4bfad..893fe5d 100755
--- a/c/wcc.h
+++ b/c/wcc.h
@@ -17,8 +17,15 @@ specific language governing permissions and limitations
 under the License.
 */
 
-/*
- *  AMCL Wang / Chow Choo (WCC)  header file
+/**
+ * @file wcc.h
+ * @author Mike Scott and Kealan McCusker
+ * @date 28th April 2016
+ * @brief Wang / Chow Choo (WCC)  header file
+ *
+ * defines structures
+ * declares functions
+ *
  */
 
 #ifndef WCC_H
diff --git a/docs/AMCL.dox b/docs/AMCL.dox
index 8cd39ec..68f1fa8 100755
--- a/docs/AMCL.dox
+++ b/docs/AMCL.dox
@@ -60,7 +60,7 @@ under the License.
 
   The source code is available from the GIT repository:
 
-  git clone https://github.com/miracl/amcl 
+  git clone https://github.com/miracl/milagro-crypto
 
   \section installonmainpage Installation
  
diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
index fd0e3a3..0150171 100644
--- a/docs/Doxyfile.in
+++ b/docs/Doxyfile.in
@@ -657,6 +657,7 @@ WARN_LOGFILE           =
 
 INPUT                  =  @CMAKE_CURRENT_SOURCE_DIR@/../c/ecdh.h \
                           @CMAKE_CURRENT_SOURCE_DIR@/../c/mpin.h \
+                          @CMAKE_CURRENT_SOURCE_DIR@/../c/wcc.c \
                           @CMAKE_CURRENT_SOURCE_DIR@/../c/rsa.h \
                           @CMAKE_CURRENT_SOURCE_DIR@/AMCL.dox