Skip to content

Commit

Permalink
Update Comment
Browse files Browse the repository at this point in the history
  • Loading branch information
Byrdman32 committed Feb 8, 2024
1 parent 888300c commit 82fc86a
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions src/RoveComm/ExternalIncludes.h
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,21 @@
#ifndef EXTERNAL_INCLUDES_H
#define EXTERNAL_INCLUDES_H

// AutonomyThread.hpp is written by the Mars Rover Design Team and is included for
// our multithreading functionality.
/******************************************************************************
* @brief Since this project is setup as a library sometimes we need to access
* our logger and globals from the host application and othertimes, in
* the case that we are testing directly within our stand-alone
* application we need to access our logger and globals from within
* the repository but not necissarily from within the library itself.
*
* The macro, __ROVECOMM_LIBRARY_MODE__, is how we can detect within
* RoveComm for High Level C++ Applications which mode we are running
* in and will tell us what can be included.
*
*
* @author Eli Byrd ([email protected])
* @date 2023-08-28
******************************************************************************/
#ifdef __ROVECOMM_LIBRARY_MODE__
#include "../../../../../src/interfaces/AutonomyThread.hpp"
#else
Expand Down

0 comments on commit 82fc86a

Please sign in to comment.