From ccc1540a90e95d4b9cc39caa5a3a76f95fa47a70 Mon Sep 17 00:00:00 2001 From: Rajiv Chitale Date: Tue, 9 Jan 2024 20:56:47 +0530 Subject: [PATCH] Enabled links, diagrams, main page in doxygen --- CompilerInterface/SerDes.py | 5 +---- docs/Doxyfile | 9 +++++---- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/CompilerInterface/SerDes.py b/CompilerInterface/SerDes.py index 8551df2..20a0ebc 100644 --- a/CompilerInterface/SerDes.py +++ b/CompilerInterface/SerDes.py @@ -49,19 +49,16 @@ def deserializeProtobuf(self, datastream): raise NotImplementedError ## Serializes data and places it in a buffer - # @param data def serializeData(self, data): self.serMap[self.data_format](data) ## Serializes data to JSON - # @param data def serializeJson(self, data): msg = json.dumps({"out": data}).encode("utf-8") hdr = len(msg).to_bytes(8, "little") self.buffer = hdr + msg ## Serializes data to bitstream - # @param data def serializeBytes(self, data): if isinstance(data, list): msg = b"".join([x.to_bytes(4, "little", signed=True) for x in data]) @@ -75,7 +72,7 @@ def serializeProtobuf(self, data): self.buffer = data ## Returns value in buffer and empties it - # @return data from output buffer + # @return Data from output buffer def getOutputBuffer(self): out = self.buffer self.buffer = None diff --git a/docs/Doxyfile b/docs/Doxyfile index 26cffa9..c72cf25 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -998,7 +998,8 @@ FILE_PATTERNS = *.c \ *.ccm \ *.c++ \ *.c++m \ - *.py + *.py \ + README.md # The RECURSIVE tag can be used to specify whether or not subdirectories should @@ -1125,7 +1126,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = README.md # The Fortran standard specifies that for fixed formatted Fortran code all # characters from position 72 are to be considered as comment. A common @@ -1147,7 +1148,7 @@ FORTRAN_COMMENT_AFTER = 72 # also VERBATIM_HEADERS is set to NO. # The default value is: NO. -SOURCE_BROWSER = NO +SOURCE_BROWSER = YES # Setting the INLINE_SOURCES tag to YES will include the body of functions, # multi-line macros, enums or list initialized variables directly into the @@ -2462,7 +2463,7 @@ HIDE_UNDOC_RELATIONS = YES # set to NO # The default value is: NO. -HAVE_DOT = NO +HAVE_DOT = YES # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed # to run in parallel. When set to 0 doxygen will base this on the number of