-
Notifications
You must be signed in to change notification settings - Fork 88
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Doxygen comments for 6 additional files #1051
base: devel
Are you sure you want to change the base?
Conversation
…t.h, exit.h, linkPair.h
…e.h, timeConverter.h, timeLord.h, unitAlgebra.h
…tory.h, mempool.h and mempoolAccessor.h
CMAKE-FORMAT TEST - PASSED |
CLANG-FORMAT TEST - PASSED |
Status Flag 'Pre-Test Inspection' - - This Pull Request Requires Inspection... The code must be inspected by a member of the Team before Testing/Merging |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some of these changes are missing important nuances. When I get more time, I will go through and make some detailed comments, but that probably won’t happen until at least next week.
bool sharesStatistics() { return (share_flags & SHARE_STATS) != 0; } | ||
|
||
/** | ||
* @return True if parent insert statistics are shared with the child | ||
*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should instead be "True if child can insert its statistics into its parent's statistics set"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Commented on a few things that should be fixed.
These are not comprehensive, still waiting on a review from @feldergast.
*/ | ||
bool print_env() const { return print_env_; } | ||
|
||
/** | ||
* @return True if the environment option is enabled | ||
*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
True if environment configuration is disabled
bool no_env_config() const { return no_env_config_; } | ||
|
||
/** | ||
* @return Logger | ||
*/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Return verbosity level
*/ | ||
SSTElementPythonModule* getPythonModule(const std::string& name); | ||
|
||
/** | ||
* @brief hasLibrary Checks to see if library exists and can be loaded | ||
* @param elemlib | ||
* @param elemlib Name of the Element Library Database |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just "Name of the element library" (not database)
Files: