Skip to content

Commit 4fbd9b4

Browse files
authored
Header files documentation (#804)
* Added documentation of "crow::App", "crow::SimpleApp", "crow" (namespace), all macros defined in "crow/app.h". * Added documentation entry for file crow/TinySHA1.hpp, namespace sha1, class sha1::SHA1, namespace crow and namespace crow::websocket * Documented crow/app.h and also improved crow/TinySHA1.hpp documentation * Update app.h
1 parent 3e9eb11 commit 4fbd9b4

File tree

10 files changed

+253
-71
lines changed

10 files changed

+253
-71
lines changed

Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -772,7 +772,7 @@ SHOW_FILES = YES
772772
# Folder Tree View (if specified).
773773
# The default value is: YES.
774774

775-
SHOW_NAMESPACES = NO
775+
SHOW_NAMESPACES = YES
776776

777777
# The FILE_VERSION_FILTER tag can be used to specify a program or script that
778778
# doxygen should invoke to get the current version for each file (typically from

include/crow/TinySHA1.hpp

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
1-
/*
2-
*
3-
* TinySHA1 - a header only implementation of the SHA1 algorithm in C++. Based
4-
* on the implementation in boost::uuid::details.
5-
*
1+
/*
62
* SHA1 Wikipedia Page: http://en.wikipedia.org/wiki/SHA-1
73
*
84
* Copyright (c) 2012-22 SAURAV MOHAPATRA <mohaps@gmail.com>
@@ -19,14 +15,35 @@
1915
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
2016
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
2117
*/
18+
19+
/**
20+
* \file TinySHA1.hpp
21+
* \author SAURAV MOHAPATRA <mohaps@gmail.com>
22+
* \date 2012-22
23+
* \brief TinySHA1 - a header only implementation of the SHA1 algorithm in C++. Based
24+
* on the implementation in boost::uuid::details.
25+
*
26+
* In this file are defined:
27+
* - sha1::SHA1
28+
*/
2229
#ifndef _TINY_SHA1_HPP_
2330
#define _TINY_SHA1_HPP_
2431
#include <cstdio>
2532
#include <cstdlib>
2633
#include <cstring>
2734
#include <stdint.h>
35+
36+
/**
37+
* \namespace sha1
38+
* \brief Here is defined the SHA1 class
39+
*/
2840
namespace sha1
2941
{
42+
/**
43+
* \class SHA1
44+
* \brief A tiny SHA1 algorithm implementation used internally in the
45+
* Crow server (specifically in crow/websocket.h).
46+
*/
3047
class SHA1
3148
{
3249
public:

0 commit comments

Comments
 (0)