Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't exclude implementations of public classes in Doxygen #1293

Closed
mossmaurice opened this issue Mar 17, 2022 · 4 comments · Fixed by #1315 or #2250
Closed

Don't exclude implementations of public classes in Doxygen #1293

mossmaurice opened this issue Mar 17, 2022 · 4 comments · Fixed by #1315 or #2250
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@mossmaurice
Copy link
Contributor

mossmaurice commented Mar 17, 2022

Brief problem description

Due to

set(DOXYGEN_EXCLUDE_PATTERNS "*/internal/*")
set(DOXYGEN_EXCLUDE_SYMBOLS "internal::*")

in doc/aspice_swe3_4/CMakeLists.txt most part of the public user API is not visible e.g. popo::Publisher

image

Tasks

  1. Re-write regular expression so that implementations of popo::Publisher, popo::Subscriber are not excluded
  2. Add set(DOXYGEN_INLINE_INHERITED_MEMB YES) so that inherited methods and members are displayed
@mossmaurice mossmaurice added the documentation Improvements or additions to documentation label Mar 17, 2022
@elBoberido
Copy link
Member

@mossmaurice I had an inspiration. What do you think about having and impl or similar folder, e.g.

include
   |- iceoryx_posh
      |- popo
      |   |- impl
      |      |- subscriber_base.hpp
      |      |- subscriber_impl.hpp
      |- subscriber.hpp

We need maybe a better name, but I guess you know what I mean.
With this we would still hide the internal header and could get the documentation from the base class.

mossmaurice added a commit to ApexAI/iceoryx that referenced this issue Apr 1, 2022
elBoberido added a commit to ApexAI/iceoryx that referenced this issue Apr 1, 2022
elBoberido added a commit to ApexAI/iceoryx that referenced this issue Apr 1, 2022
elBoberido added a commit to ApexAI/iceoryx that referenced this issue Apr 1, 2022
elBoberido added a commit to ApexAI/iceoryx that referenced this issue Apr 1, 2022
elBoberido added a commit to ApexAI/iceoryx that referenced this issue Apr 1, 2022
elBoberido added a commit to ApexAI/iceoryx that referenced this issue Apr 1, 2022
elBoberido added a commit to ApexAI/iceoryx that referenced this issue Apr 1, 2022
elBoberido added a commit to ApexAI/iceoryx that referenced this issue Apr 1, 2022
dkroenke pushed a commit to ApexAI/iceoryx that referenced this issue Apr 4, 2022
dkroenke pushed a commit to ApexAI/iceoryx that referenced this issue Apr 4, 2022
dkroenke pushed a commit to ApexAI/iceoryx that referenced this issue Apr 4, 2022
dkroenke pushed a commit to ApexAI/iceoryx that referenced this issue Apr 5, 2022
dkroenke pushed a commit to ApexAI/iceoryx that referenced this issue Apr 5, 2022
dkroenke pushed a commit to ApexAI/iceoryx that referenced this issue Apr 5, 2022
elfenpiff pushed a commit to ApexAI/iceoryx that referenced this issue Apr 12, 2022
elfenpiff pushed a commit to ApexAI/iceoryx that referenced this issue Apr 12, 2022
elfenpiff pushed a commit to ApexAI/iceoryx that referenced this issue Apr 12, 2022
andre-nguyen pushed a commit to andre-nguyen/iceoryx that referenced this issue Apr 22, 2022
andre-nguyen pushed a commit to andre-nguyen/iceoryx that referenced this issue Apr 22, 2022
andre-nguyen pushed a commit to andre-nguyen/iceoryx that referenced this issue Apr 22, 2022
@elBoberido elBoberido linked a pull request Apr 29, 2022 that will close this issue
21 tasks
@elBoberido
Copy link
Member

@mossmaurice this was fixed with #1315 from the workaround on the release branch. It's different than the proposal above but still works. Are you in favor of a different solution or are you fine with the workaround?

@mossmaurice
Copy link
Contributor Author

mossmaurice commented Apr 30, 2022

@elBoberido The workaround is ok for me long term. However, we should document this somewhere not to forget if e.g. new files are added. I suppose the CONTRIBUTING.md would be a good place. Can you add a few senteces there? Thanks!

@dkroenke
Copy link
Member

dkroenke commented Feb 2, 2023

@mossmaurice @elBoberido Is here still something to do or not?

elBoberido added a commit to elBoberido/iceoryx that referenced this issue Apr 13, 2024
elBoberido added a commit to elBoberido/iceoryx that referenced this issue Apr 13, 2024
@elBoberido elBoberido self-assigned this Apr 13, 2024
elBoberido added a commit that referenced this issue Apr 14, 2024
…-for-documentation-in-internal-headers

iox-#1293 Document workaround for documentation in internal headers
@github-project-automation github-project-automation bot moved this to Done in v3.0 Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
3 participants