Add API documentation about Search Paths
ClosedPublic

Authored by dhaumann on Dec 3 2017, 10:01 PM.

Details

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

Diff Detail

Repository
R216 Syntax Highlighting
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
dhaumann created this revision.Dec 3 2017, 10:01 PM
Restricted Application added a project: Frameworks. · View Herald TranscriptDec 3 2017, 10:01 PM
Restricted Application added a subscriber: Frameworks. · View Herald Transcript
dhaumann requested review of this revision.Dec 3 2017, 10:01 PM
vkrause accepted this revision.Dec 4 2017, 9:17 AM
This revision is now accepted and ready to land.Dec 4 2017, 9:17 AM
This revision was automatically updated to reflect the committed changes.