View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0002702 | OpenFOAM | Bug | public | 2017-09-20 17:43 | 2017-09-21 14:10 |
| Reporter | MakisH | Assigned To | chris | ||
| Priority | normal | Severity | trivial | Reproducibility | always |
| Status | closed | Resolution | fixed | ||
| Summary | 0002702: Broken links to GitHub in the Doxygen documentation of version 5. | ||||
| Description | In the C++ Source Code Guide (Doxygen documentation) of OpenFOAM 5.0 (https://cpp.openfoam.org/v5/) the links to the GitHub files are not correct, as they point to the non-existent repository "OpenFOAM-5.0", instead of the "OpenFOAM-5.x". For example, in the objectRegistry class reference: https://cpp.openfoam.org/v5/classFoam_1_1objectRegistry.html the following link is provided: https://github.com/OpenFOAM/OpenFOAM-5.0/tree/master/src/OpenFOAM/db/objectRegistry/objectRegistry.H which should be: https://github.com/OpenFOAM/OpenFOAM-5.x/blob/master/src/OpenFOAM/db/objectRegistry/objectRegistry.H The same happens in the reference of Time and all the pages I have tried until now. | ||||
| Tags | documentation, doxygen | ||||
|
|
I had made a note to myself to look into this, but failed to do it sooner. In summary, there are two problems: 1. The function "defineURL" in 'doc/Doxygen/Allwmake' is outdated, because it doesn't properly account for the new version numbering system which started with OpenFOAM 4.0. The weird thing is that I thought that this had already been fixed... 2. The intended design is that the reported link should actually point to https://github.com/OpenFOAM/OpenFOAM-5.x/blob/version-5.0/src/OpenFOAM/db/objectRegistry/objectRegistry.H - so that it would point to the file for the specific version 5.0. @chris: I haven't had the time yet to provide a patch for this and to test a sed command that can repair the files which are already available online. I haven't tested, but the following should possibly work: find html/ -name "*.html" -type f | xargs sed -i -e 'href="https://github.com/OpenFOAM/OpenFOAM-5.0/tree/master/|href="https://github.com/OpenFOAM/OpenFOAM-5.x/blob/version-5.0/|g' |
|
|
Thanks @wyldckat. Actually noticed this yesterday myself. Regarding 1), I pushed the change to 'doc/Doxygen/Allwmake' into dev and 5.x, e.g.: https://github.com/OpenFOAM/OpenFOAM-dev/commit/91abe4ffd96ab142e67ae52627a0538825bfb9ca I also ran the sed command (adding 's|...') on the v5 documentation. That seemed to work correctly. Pushing corrected files now, but note it generally takes 24hrs to clear cache at edge locations, so will test tomorrow. Will close now, reopen if there is a problem. |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2017-09-20 17:43 | MakisH | New Issue | |
| 2017-09-20 17:43 | MakisH | Tag Attached: documentation | |
| 2017-09-20 17:43 | MakisH | Tag Attached: doxygen | |
| 2017-09-20 19:14 | wyldckat | Relationship added | related to 0002565 |
| 2017-09-20 19:21 | wyldckat | Note Added: 0008786 | |
| 2017-09-20 19:21 | wyldckat | Assigned To | => chris |
| 2017-09-20 19:21 | wyldckat | Status | new => assigned |
| 2017-09-21 14:09 | chris | Note Added: 0008788 | |
| 2017-09-21 14:10 | chris | Status | assigned => closed |
| 2017-09-21 14:10 | chris | Resolution | open => fixed |
