Browse Source

Moved @file documentation above header includes to be more consistent.

release/0.19
JustinAJ 11 years ago
parent
commit
86263f7493
  1. 10
      Jupiter/ArrayList.h
  2. 4
      Jupiter/Base64.h
  3. 10
      Jupiter/DLList.h
  4. 10
      Jupiter/List.h
  5. 10
      Jupiter/Queue.h
  6. 10
      Jupiter/SLList.h
  7. 4
      Jupiter/SecureSocket.h

10
Jupiter/ArrayList.h

@ -18,14 +18,14 @@
#if !defined _ARRAYLIST_H_HEADER #if !defined _ARRAYLIST_H_HEADER
#define _ARRAYLIST_H_HEADER #define _ARRAYLIST_H_HEADER
/**
* @file ArrayList.h
* @brief Provides an array-based list implementation using the List interface.
*/
#include "Jupiter.h" #include "Jupiter.h"
#include "List.h" #include "List.h"
/**
* @file ArrayList.h
* @brief Provides an array-based list implementation using the List interface.
*/
namespace Jupiter namespace Jupiter
{ {
/** /**

4
Jupiter/Base64.h

@ -18,13 +18,13 @@
#if !defined _BASE64_H_HEADER #if !defined _BASE64_H_HEADER
#define _BASE64_H_HEADER #define _BASE64_H_HEADER
#include "Jupiter.h"
/** /**
* @file Base64.h * @file Base64.h
* @brief Provides C and C++ functions to encode/decode using base64. * @brief Provides C and C++ functions to encode/decode using base64.
*/ */
#include "Jupiter.h"
#if defined __cplusplus #if defined __cplusplus
#include <cstdint> #include <cstdint>

10
Jupiter/DLList.h

@ -18,14 +18,14 @@
#if !defined _DLLIST_H_HEADER #if !defined _DLLIST_H_HEADER
#define _DLLIST_H_HEADER #define _DLLIST_H_HEADER
/**
* @file DLList.h
* @brief Provides a generic Doubly Linked List implementation using the List interface.
*/
#include "Jupiter.h" #include "Jupiter.h"
#include "List.h" #include "List.h"
/**
* @file DLList.h
* @brief Provides a generic Doubly Linked List implementation using the List interface.
*/
namespace Jupiter namespace Jupiter
{ {
/** /**

10
Jupiter/List.h

@ -18,12 +18,12 @@
#if !defined _LIST_H_HEADER #if !defined _LIST_H_HEADER
#define _LIST_H_HEADER #define _LIST_H_HEADER
#include "Jupiter.h"
/** /**
* @file List.h * @file List.h
* @brief Provides a generic List interface. * @brief Provides a generic List interface.
*/ */
#include "Jupiter.h"
namespace Jupiter namespace Jupiter
{ {

10
Jupiter/Queue.h

@ -18,12 +18,12 @@
#if !defined _QUEUE_H_HEADER #if !defined _QUEUE_H_HEADER
#define _QUEUE_H_HEADER #define _QUEUE_H_HEADER
#include "Jupiter.h"
/** /**
* @file Queue.h * @file Queue.h
* @brief Provides a simple and efficient queue. * @brief Provides a simple and efficient queue.
*/ */
#include "Jupiter.h"
namespace Jupiter namespace Jupiter
{ {

10
Jupiter/SLList.h

@ -18,14 +18,14 @@
#if !defined _SLLIST_H_HEADER #if !defined _SLLIST_H_HEADER
#define _SLLIST_H_HEADER #define _SLLIST_H_HEADER
/**
* @file SLList.h
* @brief Provides a generic Singly Linked List implementation using the List interface.
*/
#include "Jupiter.h" #include "Jupiter.h"
#include "List.h" #include "List.h"
/**
* @file SLList.h
* @brief Provides a generic Singly Linked List implementation using the List interface.
*/
namespace Jupiter namespace Jupiter
{ {
/** /**

4
Jupiter/SecureSocket.h

@ -18,13 +18,13 @@
#if !defined _SECURESOCKET_H_HEADER #if !defined _SECURESOCKET_H_HEADER
#define _SECURESOCKET_H_HEADER #define _SECURESOCKET_H_HEADER
#include "Socket.h"
/** /**
* @file SecureSocket.h * @file SecureSocket.h
* @brief Provides an OpenSSL implementation on the Socket interface. * @brief Provides an OpenSSL implementation on the Socket interface.
*/ */
#include "Socket.h"
namespace Jupiter namespace Jupiter
{ {
/** /**

Loading…
Cancel
Save