Fixup BTranslator documentation

This commit is contained in:
Markus Himmel
2015-01-03 01:20:28 +01:00
committed by François Revol
parent 02bdb5db9a
commit b9e01b33ed
+6 -6
View File
@@ -1,5 +1,5 @@
/* /*
* Copyright 2014 Markus Himmel. All rights reserved. * Copyright 2014-2015 Markus Himmel. All rights reserved.
* Distributed under the terms of the MIT License. * Distributed under the terms of the MIT License.
* *
* Authors: * Authors:
@@ -13,14 +13,14 @@
/*! /*!
\file Translator.h \file Translator.h
\ingroup translation \ingroup translation
\ingroup libbe \ingroup libtranslation
\brief BTranslator class definition. \brief BTranslator class definition.
*/ */
/*! /*!
\file TranslationDefs.h \file TranslationDefs.h
\ingroup translation \ingroup translation
\ingroup libbe \ingroup libtranslation
\brief Defines structures and preprocessor macros that are used by the \brief Defines structures and preprocessor macros that are used by the
translation kit. translation kit.
*/ */
@@ -28,7 +28,7 @@
/*! /*!
\file TranslatorFormats.h \file TranslatorFormats.h
\ingroup translation \ingroup translation
\ingroup libbe \ingroup libtranslation
\brief Defines identifiers and structures for data formats and configuration \brief Defines identifiers and structures for data formats and configuration
messages. messages.
*/ */
@@ -36,7 +36,7 @@
/*! /*!
\class BTranslator \class BTranslator
\ingroup translation \ingroup translation
\ingroup libbe \ingroup libtranslation
\brief Abstract class that defines the necessary functionality of a \brief Abstract class that defines the necessary functionality of a
translator. translator.
@@ -279,7 +279,7 @@
TranslatorFormats.h. TranslatorFormats.h.
\param _view Where a pointer to the newly created configuration view will \param _view Where a pointer to the newly created configuration view will
be stored. be stored.
\param _extent Where the size of the newly created configureation view will \param _extent Where the size of the newly created configuration view will
be stored. be stored.
\retval B_OK Everything went well. \retval B_OK Everything went well.
\retval B_ERROR An error occurred or the method was not overriden by the \retval B_ERROR An error occurred or the method was not overriden by the