D9157: Add API documentation about Search Paths

[Dominik Haumann]

dhaumann created this revision.
dhaumann added reviewers: vkrause, cullmann.
Restricted Application added a project: Frameworks.
Restricted Application added a subscriber: Frameworks.

REVISION SUMMARY
  Currently, the search procedure for Definitions is:
  
  1. $XDG_DATA_HOME/org.kde.syntax-highlighting/syntax
  2. {$XDG_DATA_DIRS}/org.kde.syntax-highlighting/syntax // possibly many
  3. $XDG_DATA_HOME/katepart5/syntax
  4. {$XDG_DATA_DIRS}/katepart5/syntax // possibly many
  5. Qt resource: ":/org.kde.syntax-highlighting/syntax".
  6. all paths added with addCustomSearchPath()/syntax
  
  Duplicate entries are compared through the version number.
  
  The same applies to the Themes:
  
  1. $XDG_DATA_HOME/org.kde.syntax-highlighting/themes
  2. {$XDG_DATA_DIRS}/org.kde.syntax-highlighting/themes // possibly many
  3. Qt resource: ":/org.kde.syntax-highlighting/themes".
  4. all paths added with addCustomSearchPath()/themes

TEST PLAN
  make && make test

REPOSITORY
  R216 Syntax Highlighting

BRANCH
  SearchPathsDocs (branched from master)

REVISION DETAIL
  https://phabricator.kde.org/D9157

AFFECTED FILES
  src/lib/repository.h

To: dhaumann, vkrause, cullmann
Cc: #frameworks
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20171203/aad8b279/attachment.html>