Hide API docu for private/internal constructs on website

[elfenpiff]

Brief feature description

At the moment the website shows the full API documentation of constructs which are filed under the directory "internal", are private/protected nested classes or methods.

The website should only contain the public user API documentation.

Detailed information

Adjust the doxygen configuration files so that it is not generated when:

• the class is a protected/private nested class of some class
• the class/function/variable is in the namespace internal
• the methods/variables are protected or private
• the class is stored under the directory internal

[mossmaurice]

@budrus @dkroenke and myself concluded that we don't need to differentiate between public and private API. Most people will use the search functionality on iceoryx.io anyway. Hence, closing this issue.

[elBoberido]

@mossmaurice I strongly suggest to rethink this. The search functionality also lists the private header which makes it hard for users to easily grasp what they can use. Furthermore, try to search for the publisher API. It's a mess.

Oh, and I just noticed that doxygen creates the wrong include paths. Look here https://iceoryx.io/v1.0.1/API-reference/posh/Classes/structiox_1_1popo_1_1PublisherOptions/. It's #include <publisher_options.hpp> but should be include <iceoryx_posh/popo/publisher_options.hpp>. Do you know if this can be fixed? if not it might be better to nod have it there.

[elfenpiff]

@elBoberido I completely agree! And sadly somehow I did not realize that this issue was closed therefore I intervene now and reopen the issue.

[mossmaurice]

Still 3:2 for closing this issue 😛 Just kidding, I added it to the agenda of next weeks dev meetup.

Do you know if this can be fixed?

Not atm, please track this point somewhere, else it'll be forgotten. Maybe @ithier can help?

[elBoberido]

@mossmaurice I think this is more of a doxygen issue instead of mkdocs issue. I will create an issue for this

Regarding the other topic. @MatthiasKillat once proposed to slightly adjust the folder structure. I don't fully recall his proposal but it made sense when he did it. It think it was something similar to this

|- include
  |- iceoryx_hoofs
    |- cxx
    |- ...
|- src
  |- include
    |- iceoryx_hoofs
      |- internal
        |- cxx
        |- ... 

With this, the include paths would remain the same and we can also install the internal headers to the same location but it's now easy to have only the public header in doxygen.