JUCE icon indicating copy to clipboard operation
JUCE copied to clipboard

Published 20 hours ago • verified publisher icon juce-framework

Correct and clarify SpecialLocationType documentation

Open sudara opened this issue 3 years ago • 0 comments

Supersedes #1058 (wanted to submit another PR, so needed to put these commits on a branch)

👋🏼 This PR

  1. Clarifies a few incorrect paths specified in old documentation (from 15 years ago!). For example userApplicationDataDirectory on Windows no longer points to \Documents and Settings\username\Application Data, but to \Users\username\AppData\Roaming

  2. Removes a bunch of "might be/may be" language that was obscuring rather than clarifying how paths are resolved.

  3. Provides details on how special locations are resolved on Windows.

  4. Cleans up some unintentional code blocks in juce_File.h's documentation (a newline after the first line in a doc section treated the next chunk as indented code):

image

See this forum post for more detail.

Render with the changes (doxygen ran fine locally):

image

sudara avatar Apr 20 '22 21:04 sudara