A bunch of doxygen fixes

This commit is contained in:
caheckman 2021-01-27 12:03:48 -05:00
parent 8d2b737a72
commit 5d7a7c5291
27 changed files with 514 additions and 195 deletions

View file

@ -13,7 +13,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Add some terminal capabilities to the command-line interface
/// \file ifaceterm.hh
/// \brief Add some terminal capabilities to the command-line interface (IfaceStatus)
#include "interface.hh"
#ifdef __TERMINAL__
@ -23,18 +26,24 @@ extern "C" {
}
#endif
/// \brief Implement the command-line interface on top of a specific input stream
///
/// An initial input stream is provided as the base stream to parse for commands.
/// Additional input streams can be stacked by invoking scripts.
/// If the stream supports it, the stream parser recognizes special command-line editing
/// and completion keys.
class IfaceTerm : public IfaceStatus {
#ifdef __TERMINAL__
bool is_terminal; // True if the input stream is a terminal
int4 ifd; // Underlying file descriptor
struct termios itty; // Original terminal settings
bool is_terminal; ///< True if the input stream is a terminal
int4 ifd; ///< Underlying file descriptor
struct termios itty; ///< Original terminal settings
#endif
istream *sptr; // Where to get input
vector<istream *> inputstack;
int4 doCompletion(string &line,int4 cursor);
istream *sptr; ///< The base input stream for the interface
vector<istream *> inputstack; ///< Stack of nested input streams
int4 doCompletion(string &line,int4 cursor); ///< 'Complete' the current command line
virtual void readLine(string &line);
public:
IfaceTerm(const string &prmpt,istream &is,ostream &os);
IfaceTerm(const string &prmpt,istream &is,ostream &os); ///< Constructor
virtual ~IfaceTerm(void);
virtual void pushScript(const string &filename,const string &newprompt);
virtual void popScript(void);