[gem5-dev] Change in gem5/gem5[develop]: base: Tag API methods and variables in chunk_generator.hh

[Hoa Nguyen (Gerrit) via gem5-dev]

Hoa Nguyen has submitted this change. (  
https://gem5-review.googlesource.com/c/public/gem5/+/32935 )

Change subject: base: Tag API methods and variables in chunk_generator.hh
......................................................................
base: Tag API methods and variables in chunk_generator.hh

Change-Id: I8dbcef360ec1c5539fc415781729fcb86112fdbc
Signed-off-by: Hoa Nguyen <hoangu...@ucdavis.edu>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/32935
Reviewed-by: Jason Lowe-Power <power...@gmail.com>
Maintainer: Bobby R. Bruce <bbr...@ucdavis.edu>
Tested-by: kokoro <noreply+kok...@google.com>
---
M src/base/chunk_generator.hh
1 file changed, 23 insertions(+), 3 deletions(-)

Approvals:
  Jason Lowe-Power: Looks good to me, approved
  Bobby R. Bruce: Looks good to me, approved
  kokoro: Regressions pass



diff --git a/src/base/chunk_generator.hh b/src/base/chunk_generator.hh
index d1378aa..994d83a 100644
--- a/src/base/chunk_generator.hh
+++ b/src/base/chunk_generator.hh
@@ -75,6 +75,8 @@
      * @param totalSize The total size of the region.
      * @param _chunkSize The size/alignment of chunks into which
      *    the region should be decomposed.
+     *
+     * @ingroup api_chunk_generator
      */
     ChunkGenerator(Addr _startAddr, unsigned totalSize, unsigned  
_chunkSize)
         : startAddr(_startAddr), chunkSize(_chunkSize)
@@ -105,24 +107,40 @@
         sizeLeft = totalSize - curSize;
     }

-    /** Return starting address of current chunk. */
+    /**
+     * Return starting address of current chunk.
+     *
+     * @ingroup api_chunk_generator
+     */
     Addr addr() const { return curAddr; }
-    /** Return size in bytes of current chunk. */
+    /**
+     * Return size in bytes of current chunk.
+     *
+     * @ingroup api_chunk_generator
+     */
     unsigned size() const { return curSize; }

-    /** Number of bytes we have already chunked up. */
+    /**
+     * Number of bytes we have already chunked up.
+     *
+     * @ingroup api_chunk_generator
+     */
     unsigned complete() const { return curAddr - startAddr; }

     /**
      * Are we done?  That is, did the last call to next() advance
      * past the end of the region?
      * @return True if yes, false if more to go.
+     *
+     * @ingroup api_chunk_generator
      */
     bool done() const { return (curSize == 0); }

     /**
      * Is this the last chunk?
      * @return True if yes, false if more to go.
+     *
+     * @ingroup api_chunk_generator
      */
     bool last() const { return (sizeLeft == 0); }

@@ -130,6 +148,8 @@
      * Advance generator to next chunk.
      * @return True if successful, false if unsuccessful
      * (because we were at the last chunk).
+     *
+     * @ingroup api_chunk_generator
      */
     bool
     next()

--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/32935
To unsubscribe, or for help writing mail filters, visit  
https://gem5-review.googlesource.com/settings

Gerrit-Project: public/gem5
Gerrit-Branch: develop
Gerrit-Change-Id: I8dbcef360ec1c5539fc415781729fcb86112fdbc
Gerrit-Change-Number: 32935
Gerrit-PatchSet: 2
Gerrit-Owner: Hoa Nguyen <hoangu...@ucdavis.edu>
Gerrit-Reviewer: Bobby R. Bruce <bbr...@ucdavis.edu>
Gerrit-Reviewer: Hoa Nguyen <hoangu...@ucdavis.edu>
Gerrit-Reviewer: Jason Lowe-Power <power...@gmail.com>
Gerrit-Reviewer: kokoro <noreply+kok...@google.com>
Gerrit-MessageType: merged
_______________________________________________
gem5-dev mailing list -- gem5-dev@gem5.org
To unsubscribe send an email to gem5-dev-le...@gem5.org
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s