Added comments

IITH-Compilers · Jan 13, 2024 · 6b22369 · 6b22369
1 parent 7ce476e
commit 6b22369
Show file tree

Hide file tree

Showing 13 changed files with 73 additions and 1 deletion.
diff --git a/SerDes/bitstreamSerDes.cpp b/SerDes/bitstreamSerDes.cpp
@@ -1,3 +1,9 @@
+//=== MLCompilerBridge/SerDes/bitstreamSerDes.cpp - Bitstream SerDes Implementation ---*- C++ -*-===//
+//
+// Part of the MLCompilerBridge Project
+//
+//===------------------===//
+
 #include "SerDes/bitstreamSerDes.h"
 #include "MLModelRunner/Utils/JSON.h"
 #include "llvm/Support/Error.h"

diff --git a/SerDes/jsonSerDes.cpp b/SerDes/jsonSerDes.cpp
@@ -1,3 +1,9 @@
+//=== MLCBridge/SerDes/jsonSerDes.cpp - JsonSerDes class definition ===//
+//
+// Part of the MLCompilerBridge Project
+//
+//===------------------===//
+
 #include "SerDes/jsonSerDes.h"
 #include "MLModelRunner/Utils/JSON.h"
 #include "SerDes/baseSerDes.h"

diff --git a/SerDes/protobufSerDes.cpp b/SerDes/protobufSerDes.cpp
@@ -1,3 +1,9 @@
+//=== MLCompilerBridge/SerDes/protobufSerDes.cpp - Protobuf SerDes Implementation ---*- C++ -*-===//
+//
+// Part of the MLCompilerBridge Project
+//
+//===------------------===//
+
 #include "SerDes/protobufSerDes.h"
 #include "google/protobuf/descriptor.h"
 #include "google/protobuf/message.h"

diff --git a/SerDes/tensorflowSerDes.cpp b/SerDes/tensorflowSerDes.cpp
@@ -1,3 +1,9 @@
+//=== MLCompilerBridge/SerDes/tensorflowSerDes.cpp - Tensorflow SerDes Implementation ---*- C++ -*-===//
+//
+// Part of the MLCompilerBridge Project
+//
+//===------------------===//
+
 #include "SerDes/tensorflowSerDes.h"
 #include "SerDes/baseSerDes.h"
 

diff --git a/docs/Doxyfile b/docs/Doxyfile
@@ -524,7 +524,7 @@ TIMESTAMP              = NO
 # normally produced when WARNINGS is set to YES.
 # The default value is: NO.
 
-EXTRACT_ALL            = NO
+EXTRACT_ALL            = YES
 
 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
 # be included in the documentation.

diff --git a/include/MLModelRunner/C/ONNXModelRunner.h b/include/MLModelRunner/C/ONNXModelRunner.h
@@ -1,3 +1,9 @@
+//=== MLModelRunner/C/ONNXModelRunner.h - C API for ONNXModelRunner - C++ -===//
+//
+// Part of the MLCompilerBridge Project
+//
+//===------------------===//
+
 #ifndef ONNX_MODEL_RUNNER_WRAPPER_H
 #define ONNX_MODEL_RUNNER_WRAPPER_H
 

diff --git a/include/MLModelRunner/C/PipeModelRunner.h b/include/MLModelRunner/C/PipeModelRunner.h
@@ -1,3 +1,9 @@
+//=== MLCompilerBridge/include/MLModelRunner/C/PipeModelRunner.h - C API for PipeModelRunner ===//
+//
+// Part of the MLCompilerBridge Project
+//
+//===------------------===//
+
 #ifndef PIPE_MODEL_RUNNER_WRAPPER_H
 #define PIPE_MODEL_RUNNER_WRAPPER_H
 

diff --git a/include/MLModelRunner/Utils/MLConfig.h b/include/MLModelRunner/Utils/MLConfig.h
@@ -1,3 +1,9 @@
+//=== MLModelRunner/Utils/MLConfig.h - MLConfig class definition ---*- C++ -*-===//
+//
+// Part of the MLCompilerBridge Project
+//
+//===------------------===//
+
 #ifndef MLBRIDGE_CONFIG_H
 #define MLBRIDGE_CONFIG_H
 #include "llvm/Support/CommandLine.h"

diff --git a/include/SerDes/baseSerDes.h b/include/SerDes/baseSerDes.h
@@ -1,3 +1,9 @@
+//===- SerDes/baseSerDes.h - Base class for serialization and deserialization ---*- C++ -*-===//
+//
+// Part of the MLCompilerBridge Project
+//
+//===------------------===//
+
 #ifndef BASE_SERDES_H
 #define BASE_SERDES_H
 

diff --git a/include/SerDes/bitstreamSerDes.h b/include/SerDes/bitstreamSerDes.h
@@ -1,3 +1,9 @@
+//=== SerDes/bitstreamSerDes.h - Bitstream Serialization/Deserialization ---*- C++ -*-===//
+//
+// Part of the MLCompilerBridge Project
+//
+//===------------------===//
+
 #ifndef BITSTREAM_SERIALIZER_H
 #define BITSTREAM_SERIALIZER_H
 

diff --git a/include/SerDes/jsonSerDes.h b/include/SerDes/jsonSerDes.h
@@ -1,3 +1,9 @@
+//=== SerDes/jsonSerDes.h - Json Serialization/Deserialization ---*- C++
+//
+// Part of the MLCompilerBridge Project
+//
+//===------------------===//
+
 #ifndef JSON_SERIALIZER_H
 #define JSON_SERIALIZER_H
 

diff --git a/include/SerDes/protobufSerDes.h b/include/SerDes/protobufSerDes.h
@@ -1,3 +1,9 @@
+//=== SerDes/protobufSerDes.h - Protobuf Serialization/Deserialization ---*- C++
+//
+// Part of the MLCompilerBridge Project
+//
+//===------------------===//
+
 #ifndef PROTOBUF_SERIALIZER_H
 #define PROTOBUF_SERIALIZER_H
 

diff --git a/include/SerDes/tensorflowSerDes.h b/include/SerDes/tensorflowSerDes.h
@@ -1,3 +1,9 @@
+//=== SerDes/tensorflowSerDes.h - Tensorflow Serialization/Deserialization ---*- C++
+//
+// Part of the MLCompilerBridge Project
+//
+//===------------------===//
+
 #ifndef TENSORFLOW_SERIALIZER_H
 #define TENSORFLOW_SERIALIZER_H