Fix minor doxygen issues.

Doxyfile:
    Turn on EXTRACT_ALL so we get full class hierarchy info.
base/range.hh:
cpu/o3/fetch.hh:
cpu/o3/rename_map.hh:
cpu/o3/rob.hh:
dev/ide_disk.cc:
dev/tsunami.cc:
dev/tsunami.hh:
dev/tsunami_cchip.hh:
    Fix doxygen issues.

--HG--
extra : convert_revision : 9e0e8d3510b35db201459b8a3211c5e6ad5f0bb4

diff --git a/Doxyfile b/Doxyfile
index 3857e0a58c7342befa33de0b5b838da6b323bf1b..38116f6b01114230b15fa40baa05313bcbd91ca5 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -193,7 +193,7 @@ SUBGROUPING            = YES
 # Private class members and static file members will be hidden unless 
 # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
 
-EXTRACT_ALL            = NO
+EXTRACT_ALL            = YES
 
 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
 # will be included in the documentation.

diff --git a/base/range.hh b/base/range.hh
index 838e143cf9267bc444fc3ccc1090101436f5f77b..4e3e0fd6e28557ec149948472c60c40435816522 100644 (file)
--- a/base/range.hh
+++ b/base/range.hh
@@ -36,8 +36,10 @@
 /**
  * @param s range string
  * EndExclusive Ranges are in the following format:
+ * @verbatim
  *    <range> := {<start_val>}:{<end>}
  *    <start>   := <end_val> | +<delta>
+ * @endverbatim
  */
 template <class T>
 bool __parse_range(const std::string &s, T &start, T &end);

diff --git a/cpu/o3/fetch.hh b/cpu/o3/fetch.hh
index a630107622c677cc620ef010654d3d98e8ce875f..24e445f0bc743387e2c9441e221a296d11832046 100644 (file)
--- a/cpu/o3/fetch.hh
+++ b/cpu/o3/fetch.hh
@@ -109,7 +109,7 @@ class SimpleFetch
     /**
      * Looks up in the branch predictor to see if the next PC should be
      * either next PC+=MachInst or a branch target.
-     * @params next_PC Next PC variable passed in by reference.  It is
+     * @param next_PC Next PC variable passed in by reference.  It is
      * expected to be set to the current PC; it will be updated with what
      * the next PC will be.
      * @return Whether or not a branch was predicted as taken.
@@ -120,7 +120,7 @@ class SimpleFetch
      * Fetches the cache line that contains fetch_PC.  Returns any
      * fault that happened.  Puts the data into the class variable
      * cacheData.
-     * @params fetch_PC The PC address that is being fetched from.
+     * @param fetch_PC The PC address that is being fetched from.
      * @return Any fault that occured.
      */
     Fault fetchCacheLine(Addr fetch_PC);

diff --git a/cpu/o3/rename_map.hh b/cpu/o3/rename_map.hh
index 1469476ce001f174afc6c46f2b05c693b4a32332..c44c7a1eaeb24fc4a8c5f070e459efd0dd4c46c2 100644 (file)
--- a/cpu/o3/rename_map.hh
+++ b/cpu/o3/rename_map.hh
@@ -85,8 +85,7 @@ class SimpleRenameMap
     /**
      * Marks the given register as ready, meaning that its value has been
      * calculated and written to the register file.
-     * @params ready_reg The index of the physical register that is now
-     *                   ready.
+     * @param ready_reg The index of the physical register that is now ready.
      */
     void markAsReady(PhysRegIndex ready_reg);
 

diff --git a/cpu/o3/rob.hh b/cpu/o3/rob.hh
index 07ad75b52e742accda192abb3fe9b39d1ef31d7b..29ec48007800dd3f86cf8d72e3ceca6eeb0494d5 100644 (file)
--- a/cpu/o3/rob.hh
+++ b/cpu/o3/rob.hh
@@ -57,15 +57,15 @@ class ROB
 
   public:
     /** ROB constructor.
-     *  @params _numEntries Number of entries in ROB.
-     *  @params _squashWidth Number of instructions that can be squashed in a
+     *  @param _numEntries Number of entries in ROB.
+     *  @param _squashWidth Number of instructions that can be squashed in a
      *                       single cycle.
      */
     ROB(unsigned _numEntries, unsigned _squashWidth);
 
     /** Function to set the CPU pointer, necessary due to which object the ROB
      *  is created within.
-     *  @params cpu_ptr Pointer to the implementation specific full CPU object.
+     *  @param cpu_ptr Pointer to the implementation specific full CPU object.
      */
     void setCPU(FullCPU *cpu_ptr);
 
@@ -73,7 +73,7 @@ class ROB
      *  not truly required, but is useful for checking correctness.  Note
      *  that whatever calls this function must ensure that there is enough
      *  space within the ROB for the new instruction.
-     *  @params inst The instruction being inserted into the ROB.
+     *  @param inst The instruction being inserted into the ROB.
      *  @todo Remove the parameter once correctness is ensured.
      */
     void insertInst(DynInstPtr &inst);

diff --git a/dev/ide_disk.cc b/dev/ide_disk.cc
index 70cb367b6ce121973d62b36c5947659357f51e55..23d04bb5ecfe9459ae11bdfc98a23c556dcb489b 100644 (file)
--- a/dev/ide_disk.cc
+++ b/dev/ide_disk.cc
@@ -351,7 +351,7 @@ IdeDisk::dmaPrdReadDone()
 void
 IdeDisk::doDmaRead()
 {
-    /** @TODO we need to figure out what the delay actually will be */
+    /** @todo we need to figure out what the delay actually will be */
     Tick totalDiskDelay = diskDelay + (curPrd.getByteCount() / SectorSize);
 
     DPRINTF(IdeDisk, "doDmaRead, diskDelay: %d totalDiskDelay: %d\n",
@@ -455,7 +455,7 @@ IdeDisk::dmaReadDone()
 void
 IdeDisk::doDmaWrite()
 {
-    /** @TODO we need to figure out what the delay actually will be */
+    /** @todo we need to figure out what the delay actually will be */
     Tick totalDiskDelay = diskDelay + (curPrd.getByteCount() / SectorSize);
 
     DPRINTF(IdeDisk, "doDmaWrite, diskDelay: %d totalDiskDelay: %d\n",

diff --git a/dev/tsunami.cc b/dev/tsunami.cc
index 7bd066072addb36decc7a29cdb93db7740390622..760848a006cced3f4332e5d0cd805c6a1509682a 100644 (file)
--- a/dev/tsunami.cc
+++ b/dev/tsunami.cc
@@ -26,7 +26,8 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-/** @file Implementation of Tsunami platform.
+/** @file
+ * Implementation of Tsunami platform.
  */
 
 #include <deque>

diff --git a/dev/tsunami.hh b/dev/tsunami.hh
index c6ed4eb514da1d07c3b4d07329679f75fec7f47e..7fd91d5b269ab5b7f289329e971338401fe61103 100644 (file)
--- a/dev/tsunami.hh
+++ b/dev/tsunami.hh
@@ -84,9 +84,7 @@ class Tsunami : public Platform
     /**
      * Constructor for the Tsunami Class.
      * @param name name of the object
-     * @param con pointer to the console
-     * @param intrcontrol pointer to the interrupt controller
-     * @param intrFreq frequency that interrupts happen
+     * @param intrctrl pointer to the interrupt controller
      */
     Tsunami(const std::string &name, System *s, IntrControl *intctrl,
             PciConfigAll *pci);

diff --git a/dev/tsunami_cchip.hh b/dev/tsunami_cchip.hh
index 3a2e80c921439c9a11facd3674269cfd912f3ae3..931a0fb417c52ffe9e531caafeabe801a05b4634 100644 (file)
--- a/dev/tsunami_cchip.hh
+++ b/dev/tsunami_cchip.hh
@@ -139,7 +139,7 @@ class TsunamiCChip : public PioDevice
 
     /**
      * clear a timer interrupt previously posted to the CPU.
-     * @param interrupt the cpu number to clear(bitvector)
+     * @param itintr the cpu number to clear(bitvector)
      */
     void clearITI(uint64_t itintr);