misc: Update documentation of SimObject related APIs
authorMuhammad Sarmad Saeed <mssaeed@ucdavis.edu>
Fri, 24 Jul 2020 22:08:27 +0000 (22:08 +0000)
committerBobby R. Bruce <bbruce@ucdavis.edu>
Fri, 11 Sep 2020 05:38:53 +0000 (05:38 +0000)
commitb2847f43c91e27f43bd4ac08abd528efcf00f2fd
treecfe5b3ed3d49ed6b2d057577df4e35c3eccdb0cd
parent7957b1c43b3df2c9e9b6ec17eb7fc97976c9988d
misc: Update documentation of SimObject related APIs

Updated documentation of Drain, Serialize, Evnet queue and Simobject
APIs. Made some corrections to where the documentation was available
in the code but did not appear in the documentation.

Change-Id: I5254e87eb5663232e824bcd5592da0a04eba673b
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/31814
Reviewed-by: Ayaz Akram <yazakram@ucdavis.edu>
Reviewed-by: Bobby R. Bruce <bbruce@ucdavis.edu>
Maintainer: Jason Lowe-Power <power.jg@gmail.com>
Tested-by: kokoro <noreply+kokoro@google.com>
src/sim/drain.hh
src/sim/eventq.hh
src/sim/serialize.cc
src/sim/serialize.hh
src/sim/sim_object.hh