Browse Source

fix comment

David Rose 19 years ago
parent
commit
b600ff2aa5
2 changed files with 12 additions and 4 deletions
  1. 6 2
      panda/src/putil/load_prc_file.cxx
  2. 6 2
      panda/src/putil/load_prc_file.h

+ 6 - 2
panda/src/putil/load_prc_file.cxx

@@ -29,8 +29,8 @@
 //  Description: A convenience function for loading explicit prc files
 //  Description: A convenience function for loading explicit prc files
 //               from a disk file or from within a multifile (via the
 //               from a disk file or from within a multifile (via the
 //               virtual file system).  Save the return value and pass
 //               virtual file system).  Save the return value and pass
-//               it to unload_prc_file() if you ever want to load this
-//               file later.
+//               it to unload_prc_file() if you ever want to unload
+//               this file later.
 //
 //
 //               The filename is first searched along the default prc
 //               The filename is first searched along the default prc
 //               search path, and then also along the model path, for
 //               search path, and then also along the model path, for
@@ -116,6 +116,10 @@ load_prc_file_data(const string &name, const string &data) {
 //               prc file that was previously loaded by
 //               prc file that was previously loaded by
 //               load_prc_file().  Returns true if successful, false
 //               load_prc_file().  Returns true if successful, false
 //               if the file was unknown.
 //               if the file was unknown.
+//
+//               After this function has been called, the ConfigPage
+//               pointer is no longer valid and should not be used
+//               again.
 ////////////////////////////////////////////////////////////////////
 ////////////////////////////////////////////////////////////////////
 bool
 bool
 unload_prc_file(ConfigPage *page) {
 unload_prc_file(ConfigPage *page) {

+ 6 - 2
panda/src/putil/load_prc_file.h

@@ -30,8 +30,8 @@ BEGIN_PUBLISH
 //  Description: A convenience function for loading explicit prc files
 //  Description: A convenience function for loading explicit prc files
 //               from a disk file or from within a multifile (via the
 //               from a disk file or from within a multifile (via the
 //               virtual file system).  Save the return value and pass
 //               virtual file system).  Save the return value and pass
-//               it to unload_prc_file() if you ever want to load this
-//               file later.
+//               it to unload_prc_file() if you ever want to unload
+//               this file later.
 //
 //
 //               The filename is first searched along the default prc
 //               The filename is first searched along the default prc
 //               search path, and then also along the model path, for
 //               search path, and then also along the model path, for
@@ -67,6 +67,10 @@ load_prc_file_data(const string &name, const string &data);
 //               prc file that was previously loaded by
 //               prc file that was previously loaded by
 //               load_prc_file().  Returns true if successful, false
 //               load_prc_file().  Returns true if successful, false
 //               if the file was unknown.
 //               if the file was unknown.
+//
+//               After this function has been called, the ConfigPage
+//               pointer is no longer valid and should not be used
+//               again.
 ////////////////////////////////////////////////////////////////////
 ////////////////////////////////////////////////////////////////////
 EXPCL_PANDA bool
 EXPCL_PANDA bool
 unload_prc_file(ConfigPage *page);
 unload_prc_file(ConfigPage *page);