The website shows documentation of the wrappers in the nice looking style. That is perfect. Most users will be interested only in this documentation.
But we also have developers. The source code contains many strings in all parts of the extension, not just wrappers, that are not propagated to the web. I think that it makes sense to statically generate the doxygen documentation in the doxygen css and push that to the web.
Each developer can generate their own version. I sometimes update https://www.fit.vutbr.cz/~ipolcak/jsr/doxygen/html/.
Metadata Update from @polcak: - Issue assigned to rlafuente
We've added a link to the source view in Pagure, would this suffice? We'll style it in more detail if you agree.
We can look into generating the Doxygen pages, but would like to be sure because it will be quite some work :) and maybe a link to the source can fit the same purpose?
<img alt="Screenshot_2022-05-13_14-33-51.png" src="/JShelter/webextension/issue/raw/files/97925cd7dbb2d8927ad2d947b34435370208c1b294b1231cb52d11cdef5f9bea-Screenshot_2022-05-13_14-33-51.png" />
@rlafuente Thanks. This is useful. But the code is only accessible for the wrappers. The code is not linked in the JSS/NBS/FPD key protection page. Additionally, doxygen allows to generate docs for other parts of the extension including call graphs, see https://www.fit.vutbr.cz/~ipolcak/jsr/doxygen/html/options__domains_8js.html. I think that the current framework would not be able to generate such pages.
Now that we have the auto deployment of the web pages, if we added doxygen to the pipeline, it should not require much work and would be updated instantly.
There is now a 'technical docs' link on each wrapper that takes you to a Doxygen page.
Is this sufficient to close the issue?
This is now available on the live site. Closing as completed
Metadata Update from @rlafuente: - Issue close_status updated to: Fixed - Issue status updated to: Closed (was: Open)
Hello Ricardo,
sorry for me not replying earlier. My last comment is still valid. The code is only accessible for the wrappers. Not for other shields of the extension like JSS/NBS/FPD key protection page, e.g. https://jshelter.org/nbs/.
One option to solve the issue is adding the "technical docs" link to the menu under "Developer notes"?
Metadata Update from @polcak: - Issue status updated to: Open (was: Closed)
Log in to comment on this ticket.