search

cppalliance / mrdocs

MrDocs: A Clang/LLVM tool for building reference documentation from C++ code and javadoc comments.
https://mrdocs.com
Other
66 stars 16 forks source link

Command line option --output now takes paths relative to cwd #571

Closed fpelliccioni closed 4 weeks ago

fpelliccioni commented 1 month ago

Fixes https://github.com/cppalliance/mrdocs/issues/529

alandefreitas commented 1 month ago

The bigger question here is whether Doxygen does that. IIRC, doxygen renders the paths relative to the Doxyfile. We have to ensure what their behavior is.

fpelliccioni commented 4 weeks ago
  • Does doxygen allow these values to be passed on the command line?

I tested doxygen, and it doesn't seem to support passing the output directory as an argument to the executable. Doxygen allows specifying the OUTPUT_DIRECTORY in the config file, and this directory is relative to where doxygen is run, not where the config file is located.

  • Is our policy in the command line relative to the current working directory, and any setting in mrdocs.yml relative to mrdocs.yml?

I'm not entirely sure I understand this question.

  • Are there other values we need to adjust? Many other paths can be passed in the command line.

I'll check this and report back on whether there are other values that need adjustment to ensure consistency.

fpelliccioni commented 4 weeks ago

Following Alan's comment here, I'm closing this PR. Alan clarified that paths should be relative to mrdocs.yml and that this behavior should be better documented.

Thanks for all the feedback and understanding.