Skip to content

Commit

Permalink
Enabled links, diagrams, main page in doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
RajivChitale committed Jan 9, 2024
1 parent a9dac8d commit ccc1540
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
5 changes: 1 addition & 4 deletions CompilerInterface/SerDes.py
Original file line number Diff line number Diff line change
Expand Up @@ -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])
Expand All @@ -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
Expand Down
9 changes: 5 additions & 4 deletions docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit ccc1540

Please sign in to comment.