Skip to content

Commit

Permalink
further doxygen comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
William Emfinger committed Mar 17, 2016
1 parent 6d0c9fe commit e408717
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/pnp2/include/pnp2/NetworkProfile.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/** \file NetworkProfile.hpp
*
* This file declares the ResourceEntry and NetworkProfile classes.
* This file declares the Network::ResourceEntry and
* Network::NetworkProfile classes.
*/

#ifndef NETWORK_PROFILE_HPP
Expand Down
13 changes: 13 additions & 0 deletions src/pnp2/include/pnp2/receiver.hpp
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/** \file receiver.hpp
*
* This file declares the Network::receiver class
*/

#ifndef NETWORK_RECEIVER_HPP
#define NETWORK_RECEIVER_HPP

Expand All @@ -13,6 +18,14 @@

namespace Network
{
/**
Allows for the reception of data through a (possibly fixed-size)
buffer at a configurable rate that can vary as a function of
time. Optionally enables out-of-band (oob) communication to
senders to shut them off if the buffer is filling up too fast.
The receiver also records the reception of data (size, time) into
memory for later dump to disk.
*/
class receiver
{
public:
Expand Down
18 changes: 18 additions & 0 deletions src/pnp2/include/pnp2/sender.hpp
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/** \file sender.hpp
*
* This file declares the Network::sender class.
*/

#ifndef NETWORK_SENDER_HPP
#define NETWORK_SENDER_HPP

Expand All @@ -16,8 +21,21 @@

namespace Network
{
/**
Exception class thrown when application exceeds allowed data
production.
*/
class Exceeded_Production_profile {}; // sender-side exception

/**
Allows for the sending of data (possibly through a buffer) at a
configurable rate and with configurable push-back to inform if
the rate has been exceeded. Can also optionally receive
out-of-band (oob) push-backs from its associated receiver classes
to disable sending while they empty their receive buffers. The
sender also records the sending of data (size, time) into memory
for later dump to disk.
*/
class sender
{
public:
Expand Down

0 comments on commit e408717

Please sign in to comment.