From 22c7699fa170a24f571df63c39ec02370d591832 Mon Sep 17 00:00:00 2001 From: Robert Osfield Date: Wed, 7 May 2008 14:30:58 +0000 Subject: [PATCH] From Bob Kuehne, Added doxygen docs clarification of ReadResult enum values --- include/osgDB/ReaderWriter | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/include/osgDB/ReaderWriter b/include/osgDB/ReaderWriter index 3839e1556..f6aca6cbd 100644 --- a/include/osgDB/ReaderWriter +++ b/include/osgDB/ReaderWriter @@ -160,11 +160,11 @@ class OSGDB_EXPORT ReaderWriter : public osg::Object enum ReadStatus { - FILE_NOT_HANDLED, - FILE_NOT_FOUND, - FILE_LOADED, - FILE_LOADED_FROM_CACHE, - ERROR_IN_READING_FILE + FILE_NOT_HANDLED, //!< file is not appropriate for this file reader, due to some incompatibility, but *not* a read error + FILE_NOT_FOUND, //!< file could not be found or could not be read + FILE_LOADED, //!< file successfully found, loaded, and converted into osg + FILE_LOADED_FROM_CACHE, //!< file found in cache and returned + ERROR_IN_READING_FILE //!< file found, loaded, but an error was encountered during processing }; ReadResult(ReadStatus status=FILE_NOT_HANDLED):_status(status) {}