You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You have not many doc comments. Though there's some other comments that could probably be repurposed. (Doxygen-style comments are a little finicky, but putting API documentation in your header files is a very good idea.)
I recommend putting brief descriptions (@brief) in header files (together with the likes of @param and @return) but leaving detailed descriptions (@details) for the .cpp files where you do the implementations. That seems to produce the best results overall.
For example, in PCC_Writer.h (no @return because there's no result value):
/*! * @brief Write out the structure after the program has computed its contents. * @param new_cells_design Structure to write out*/voidPCC_Writer(CellsDesign &new_cells_design);
In PCC_Writer.cpp:
/** * @details * Read PCC Writer specifications from the writer.ini file and output of the * current configuration to the screen and .log file.*/voidPCC_Writer(CellsDesign &new_cells_design) {
....
The text was updated successfully, but these errors were encountered:
You have not many doc comments. Though there's some other comments that could probably be repurposed. (Doxygen-style comments are a little finicky, but putting API documentation in your header files is a very good idea.)
I recommend putting brief descriptions (
@brief
) in header files (together with the likes of@param
and@return
) but leaving detailed descriptions (@details
) for the.cpp
files where you do the implementations. That seems to produce the best results overall.For example, in
PCC_Writer.h
(no@return
because there's no result value):In
PCC_Writer.cpp
:The text was updated successfully, but these errors were encountered: