Browse Source

Assorted docstring fixes

Closes #1588
kamgha 1 year ago
parent
commit
fe63dee524
3 changed files with 6 additions and 6 deletions
  1. 1 1
      panda/src/express/multifile.I
  2. 4 4
      panda/src/gobj/texture.I
  3. 1 1
      panda/src/text/fontPool.I

+ 1 - 1
panda/src/express/multifile.I

@@ -68,7 +68,7 @@ get_timestamp() const {
 }
 }
 
 
 /**
 /**
- * Changes the overall mudification timestamp of the multifile.  Note that this
+ * Changes the overall modification timestamp of the multifile.  Note that this
  * will be reset to the current time every time you modify a subfile.
  * will be reset to the current time every time you modify a subfile.
  * Only set this if you know what you are doing!
  * Only set this if you know what you are doing!
  */
  */

+ 4 - 4
panda/src/gobj/texture.I

@@ -1895,7 +1895,7 @@ set_filename(const Filename &filename) {
 }
 }
 
 
 /**
 /**
- * Removes the alpha filename, if it was previously set.  See set_filename().
+ * Removes the filename, if it was previously set.  See set_filename().
  */
  */
 INLINE void Texture::
 INLINE void Texture::
 clear_filename() {
 clear_filename() {
@@ -1911,8 +1911,8 @@ clear_filename() {
  * The Texture's get_filename() function returns the name of the image file
  * The Texture's get_filename() function returns the name of the image file
  * that was loaded into the buffer.  In the case where a texture specified two
  * that was loaded into the buffer.  In the case where a texture specified two
  * separate files to load, a 1- or 3-channel color image and a 1-channel alpha
  * separate files to load, a 1- or 3-channel color image and a 1-channel alpha
- * image, this Filename is update to contain the name of the image file that
- * was loaded into the buffer's alpha channel.
+ * image, the alpha_filename is updated to contain the name of the image file
+ * that was loaded into the buffer's alpha channel.
  */
  */
 INLINE void Texture::
 INLINE void Texture::
 set_alpha_filename(const Filename &alpha_filename) {
 set_alpha_filename(const Filename &alpha_filename) {
@@ -1942,7 +1942,7 @@ set_fullpath(const Filename &fullpath) {
 }
 }
 
 
 /**
 /**
- * Removes the alpha fullpath, if it was previously set.  See set_fullpath().
+ * Removes the fullpath, if it was previously set.  See set_fullpath().
  */
  */
 INLINE void Texture::
 INLINE void Texture::
 clear_fullpath() {
 clear_fullpath() {

+ 1 - 1
panda/src/text/fontPool.I

@@ -53,7 +53,7 @@ add_font(const std::string &filename, TextFont *font) {
 /**
 /**
  * Removes the indicated font from the pool, indicating it will never be
  * Removes the indicated font from the pool, indicating it will never be
  * loaded again; the font may then be freed.  If this function is never
  * loaded again; the font may then be freed.  If this function is never
- * called, a reference count will be maintained on every font every loaded,
+ * called, a reference count will be maintained on every font ever loaded,
  * and fonts will never be freed.
  * and fonts will never be freed.
  */
  */
 INLINE void FontPool::
 INLINE void FontPool::