search

accellera-official / systemc

SystemC Reference Implementation
https://systemc.org/overview/systemc/
Apache License 2.0
475 stars 152 forks source link

Broken CMake Configuration #47

Closed AmeyaVS closed 7 months ago

AmeyaVS commented 1 year ago

It seems the CMake Configuration: BUILD_SOURCE_DOCUMENTATION is broken. Even After enabling the said configuration parameter to ON. I am not able to observe any Doxygen Generated HTML Documentation for the SystemC sources.

dcblack commented 1 year ago

Do you have doxygen and dot installed?

AmeyaVS commented 1 year ago

Yes, I have them installed.

AmeyaVS commented 1 year ago

Seems like this and other associated commits disabled the Doxygen Documentation generations: c5ba24e

dcblack commented 1 year ago

To re-enable, simply add the following command to the top-level CMakeLists.txt file:

# Place this after add_subdirectory (srcs) 
add_subdirectory (docs)

As to why it was removed, I am uncertain.

dcblack commented 1 year ago

Although this is useful for understanding SystemC, be careful not to depend on it to document the proper API. IEEE-1666-2011 is the current official API.

AmeyaVS commented 1 year ago

One will all need to comment the following line to enable it: https://github.com/accellera-official/systemc/blob/master/docs/CMakeLists.txt#L45 It seems this file is also removed from the source.

Though I agree IEEE standard is the current official API. But having a local documentation is much easier to work, searches can be indexed etc.

barnasc commented 7 months ago

CMakeLists.txt at top-level and in /docs directory are fixed. Feel free to reopen the issue if the issue remains at your end.