From 67e99a217bd88a289d997b73f3e7cae6019bc22f Mon Sep 17 00:00:00 2001 From: manuel Date: Wed, 13 May 2009 17:01:15 +0200 Subject: fixing doxygen documentation --- ue3/mycpu/ccpu.h | 2 +- ue3/mycpu/cdat.h | 20 ++++++++++---------- ue3/mycpu/cdisplay.h | 1 + ue3/mycpu/cinstruction.h | 5 +++-- ue3/mycpu/instructions.h | 24 ++++++++++++++++++++++++ 5 files changed, 39 insertions(+), 13 deletions(-) (limited to 'ue3') diff --git a/ue3/mycpu/ccpu.h b/ue3/mycpu/ccpu.h index 05b5c03..6849623 100644 --- a/ue3/mycpu/ccpu.h +++ b/ue3/mycpu/ccpu.h @@ -106,7 +106,7 @@ class CCPU /** * @method setProgram * @brief set program to execute - * @param memory pointer to program + * @param program pointer to program * @return - * @globalvars none * @exception none diff --git a/ue3/mycpu/cdat.h b/ue3/mycpu/cdat.h index c656b99..a533fae 100644 --- a/ue3/mycpu/cdat.h +++ b/ue3/mycpu/cdat.h @@ -102,7 +102,7 @@ class CDatT /** * @method operator< * @brief implementation of operator < - * @param reference to CDatT + * @param x reference to CDatT * @return true if cdat is less than object x * @globalvars none * @exception none @@ -116,7 +116,7 @@ class CDatT /** * @method operator== * @brief implementation of operator == - * @param reference to CDatT + * @param x reference to CDatT * @return true if cdat equals object x * @globalvars none * @exception none @@ -130,7 +130,7 @@ class CDatT /** * @method operator+= * @brief implementation of operator += - * @param reference to CDatT + * @param x reference to CDatT * @return refecence to CDatT * @globalvars none * @exception none @@ -145,7 +145,7 @@ class CDatT /** * @method operator-= * @brief implementation of operator -= - * @param reference to CDatT + * @param x reference to CDatT * @return refecence to CDatT * @globalvars none * @exception none @@ -160,7 +160,7 @@ class CDatT /** * @method operator*= * @brief implementation of operator *= - * @param reference to CDatT + * @param x reference to CDatT * @return refecence to CDatT * @globalvars none * @exception none @@ -175,7 +175,7 @@ class CDatT /** * @method operator/= * @brief implementation of operator /= - * @param reference to CDatT + * @param x reference to CDatT * @return refecence to CDatT * @globalvars none * @exception none @@ -190,7 +190,7 @@ class CDatT /** * @method operator%= * @brief implementation of operator %= - * @param reference to CDatT + * @param x reference to CDatT * @return refecence to CDatT * @globalvars none * @exception none @@ -205,7 +205,7 @@ class CDatT /** * @method operator|= * @brief implementation of operator |= - * @param reference to CDatT + * @param x reference to CDatT * @return refecence to CDatT * @globalvars none * @exception none @@ -220,7 +220,7 @@ class CDatT /** * @method operator&= * @brief implementation of operator &= - * @param reference to CDatT + * @param x reference to CDatT * @return refecence to CDatT * @globalvars none * @exception none @@ -235,7 +235,7 @@ class CDatT /** * @method operator^= * @brief implementation of operator ^= - * @param reference to CDatT + * @param x reference to CDatT * @return refecence to CDatT * @globalvars none * @exception none diff --git a/ue3/mycpu/cdisplay.h b/ue3/mycpu/cdisplay.h index c2a84a6..0a0a723 100644 --- a/ue3/mycpu/cdisplay.h +++ b/ue3/mycpu/cdisplay.h @@ -68,6 +68,7 @@ class CDisplay protected: /* members */ + /** name of display */ std::string m_name; }; diff --git a/ue3/mycpu/cinstruction.h b/ue3/mycpu/cinstruction.h index 942d8cf..4cc69de 100644 --- a/ue3/mycpu/cinstruction.h +++ b/ue3/mycpu/cinstruction.h @@ -50,7 +50,7 @@ class CInstruction /** * @method operator== * @brief implementation of operator == - * @param reference to std::string + * @param name reference to std::string * @return true if instructionname is name * @globalvars none * @exception none @@ -109,7 +109,7 @@ class CInstruction * @method operator<< * @brief Shift/output operator for outputstream * @param stream reference to outputstream - * @param cdat object which will be printed to stream + * @param instr object which will be printed to stream * @return reference to outputstream * @globalvars none * @exception none @@ -180,6 +180,7 @@ class CInstruction protected: /* members */ + /** name of instruction */ std::string m_name; }; diff --git a/ue3/mycpu/instructions.h b/ue3/mycpu/instructions.h index a52b991..4c36562 100644 --- a/ue3/mycpu/instructions.h +++ b/ue3/mycpu/instructions.h @@ -35,6 +35,7 @@ class CInstructionInc void execute(CCPU *cpu); protected: + /** register number */ unsigned m_regidx1; }; @@ -64,6 +65,7 @@ class CInstructionDec void execute(CCPU *cpu); protected: + /** register number */ unsigned m_regidx1; }; @@ -93,8 +95,11 @@ class CInstructionAdd void execute(CCPU *cpu); protected: + /** register number */ unsigned m_regidx1; + /** register number */ unsigned m_regidx2; + /** register number */ unsigned m_regidx3; }; @@ -124,8 +129,11 @@ class CInstructionSub void execute(CCPU *cpu); protected: + /** register number */ unsigned m_regidx1; + /** register number */ unsigned m_regidx2; + /** register number */ unsigned m_regidx3; }; @@ -155,8 +163,11 @@ class CInstructionMul void execute(CCPU *cpu); protected: + /** register number */ unsigned m_regidx1; + /** register number */ unsigned m_regidx2; + /** register number */ unsigned m_regidx3; }; @@ -186,8 +197,11 @@ class CInstructionDiv void execute(CCPU *cpu); protected: + /** register number */ unsigned m_regidx1; + /** register number */ unsigned m_regidx2; + /** register number */ unsigned m_regidx3; }; @@ -217,7 +231,9 @@ class CInstructionLoad void execute(CCPU *cpu); protected: + /** register number */ unsigned m_regidx1; + /** register number */ unsigned m_regidx2; }; @@ -247,7 +263,9 @@ class CInstructionStore void execute(CCPU *cpu); protected: + /** register number */ unsigned m_regidx1; + /** register number */ unsigned m_regidx2; }; @@ -277,6 +295,7 @@ class CInstructionTest void execute(CCPU *cpu); protected: + /** register number */ unsigned m_regidx1; }; @@ -334,6 +353,7 @@ class CInstructionJumpA void execute(CCPU *cpu); protected: + /** labelname */ std::string m_addr; }; @@ -363,6 +383,7 @@ class CInstructionJumpZ void execute(CCPU *cpu); protected: + /** labelname */ std::string m_addr; }; @@ -392,6 +413,7 @@ class CInstructionJumpS void execute(CCPU *cpu); protected: + /** labelname */ std::string m_addr; }; @@ -421,7 +443,9 @@ class CInstructionWrite void execute(CCPU *cpu); protected: + /** register number */ unsigned m_regidx1; + /** device name */ std::string m_dev; }; -- cgit v1.2.3