[tf.lite] Documentation fixes:

1. Add DOxygen \file directives to file-level comments.
   This is needed because without these, the file-level comments get
   (wrongly) attached to whatever follows, typically 'namespace tflite'.

2. Fix some cut-and-paste errors in the documentation.

3. Change top-level file comments for interpreter.h and
   optional_debug_tools.h to use DOxygen markup.

4. Fix a grammar error: "versions ... doesn't ..." => "versions ... don't".

PiperOrigin-RevId: 321807896
Change-Id: I8ffd2cc393a235a270022479c605c70afbe4078d
This commit is contained in:
A. Unique TensorFlower 2020-07-17 10:41:14 -07:00 committed by TensorFlower Gardener
parent a15c3bcd9a
commit 57b9563b48
7 changed files with 15 additions and 14 deletions

View File

@ -12,8 +12,8 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
==============================================================================*/ ==============================================================================*/
// Main abstraction controlling the tflite interpreter. /// \file
// See context.h for the API for defining operations (TfLiteRegistration). /// Memory management for TF Lite.
#ifndef TENSORFLOW_LITE_ALLOCATION_H_ #ifndef TENSORFLOW_LITE_ALLOCATION_H_
#define TENSORFLOW_LITE_ALLOCATION_H_ #define TENSORFLOW_LITE_ALLOCATION_H_

View File

@ -12,8 +12,9 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
==============================================================================*/ ==============================================================================*/
// Main abstraction controlling the tflite interpreter. /// \file
// See context.h for the API for defining operations (TfLiteRegistration). /// Main abstraction controlling the tflite interpreter.
/// See context.h for the API for defining operations (TfLiteRegistration).
#ifndef TENSORFLOW_LITE_INTERPRETER_H_ #ifndef TENSORFLOW_LITE_INTERPRETER_H_
#define TENSORFLOW_LITE_INTERPRETER_H_ #define TENSORFLOW_LITE_INTERPRETER_H_

View File

@ -12,9 +12,8 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
==============================================================================*/ ==============================================================================*/
/// Deserialization infrastructure for tflite. Provides functionality /// \file
/// to go from a serialized tflite model in flatbuffer format to an /// Provides functionality to construct an interpreter for a model.
/// interpreter.
/// ///
#ifndef TENSORFLOW_LITE_INTERPRETER_BUILDER_H_ #ifndef TENSORFLOW_LITE_INTERPRETER_BUILDER_H_
#define TENSORFLOW_LITE_INTERPRETER_BUILDER_H_ #define TENSORFLOW_LITE_INTERPRETER_BUILDER_H_

View File

@ -12,9 +12,8 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
==============================================================================*/ ==============================================================================*/
/// Deserialization infrastructure for tflite. Provides functionality /// \file
/// to go from a serialized tflite model in flatbuffer format to an /// Defines tflite::Interpreter and tflite::InterpreterBuilder.
/// interpreter.
/// ///
#ifndef TENSORFLOW_LITE_MODEL_H_ #ifndef TENSORFLOW_LITE_MODEL_H_
#define TENSORFLOW_LITE_MODEL_H_ #define TENSORFLOW_LITE_MODEL_H_

View File

@ -12,9 +12,10 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
==============================================================================*/ ==============================================================================*/
/// \file
/// Deserialization infrastructure for tflite. Provides functionality /// Deserialization infrastructure for tflite. Provides functionality
/// to go from a serialized tflite model in flatbuffer format to an /// to go from a serialized tflite model in flatbuffer format to an
/// interpreter. /// in-memory representation of the model.
/// ///
#ifndef TENSORFLOW_LITE_MODEL_BUILDER_H_ #ifndef TENSORFLOW_LITE_MODEL_BUILDER_H_
#define TENSORFLOW_LITE_MODEL_BUILDER_H_ #define TENSORFLOW_LITE_MODEL_BUILDER_H_

View File

@ -23,7 +23,7 @@ limitations under the License.
namespace tflite { namespace tflite {
// Some versions of gcc doesn't support partial specialization in class scope, // Some versions of gcc don't support partial specialization in class scope,
// so these are defined in a namescope. // so these are defined in a namescope.
namespace op_resolver_hasher { namespace op_resolver_hasher {
template <typename V> template <typename V>

View File

@ -12,8 +12,9 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
==============================================================================*/ ==============================================================================*/
// Optional debugging functionality. For small sized binaries, these are not /// \file
// needed. /// Optional debugging functionality.
/// For small sized binaries, these are not needed.
#ifndef TENSORFLOW_LITE_OPTIONAL_DEBUG_TOOLS_H_ #ifndef TENSORFLOW_LITE_OPTIONAL_DEBUG_TOOLS_H_
#define TENSORFLOW_LITE_OPTIONAL_DEBUG_TOOLS_H_ #define TENSORFLOW_LITE_OPTIONAL_DEBUG_TOOLS_H_