From 63c0fcd4f77b98f5c167f50876329e407aef84dc Mon Sep 17 00:00:00 2001
From: Neil <nyamatongwe@gmail.com>
Date: Mon, 23 Oct 2017 09:19:11 +1100
Subject: Backport: Document style metadata APIs.

Backport of changeset 6405:0849bae316da.
---
 doc/ScintillaDoc.html | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'doc/ScintillaDoc.html')

diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html
index b3170a148..42242c606 100644
--- a/doc/ScintillaDoc.html
+++ b/doc/ScintillaDoc.html
@@ -6617,6 +6617,10 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
      <a class="message" href="#SCI_GETPRIMARYSTYLEFROMSTYLE">SCI_GETPRIMARYSTYLEFROMSTYLE(int style) &rarr; int</a><br />
      <a class="message" href="#SCI_SETIDENTIFIERS">SCI_SETIDENTIFIERS(int style, const char *identifiers)</a><br />
      <a class="message" href="#SCI_PRIVATELEXERCALL">SCI_PRIVATELEXERCALL(int operation, int pointer) &rarr; int</a><br />
+     <a class="message" href="#SCI_GETNAMEDSTYLES">SCI_GETNAMEDSTYLES &rarr; int</a><br />
+     <a class="message" href="#SCI_NAMEOFSTYLE">SCI_NAMEOFSTYLE(int style, char *name) &rarr; int</a><br />
+     <a class="message" href="#SCI_TAGSOFSTYLE">SCI_TAGSOFSTYLE(int style, char *tags) &rarr; int</a><br />
+     <a class="message" href="#SCI_DESCRIPTIONOFSTYLE">SCI_DESCRIPTIONOFSTYLE(int style, char *description) &rarr; int</a><br />
 
     <p><b id="SCI_SETLEXER">SCI_SETLEXER(int lexer)</b><br />
      <b id="SCI_GETLEXER">SCI_GETLEXER &rarr; int</b><br />
@@ -6794,6 +6798,23 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
     <p><b id="SCI_PRIVATELEXERCALL">SCI_PRIVATELEXERCALL(int operation, int pointer) &rarr; int</b><br />
      Call into a lexer in a way not understood by Scintilla.</p>
 
+    <h3 id="StyleMetadata">Style Metadata</h3>
+    <p>Lexers may provide information on the styles they use.
+    Lexers have to explicitly support this feature by implementing particular methods.</p>
+
+    <p><b id="SCI_GETNAMEDSTYLES">SCI_GETNAMEDSTYLES &rarr; int</b><br />
+     Retrieve the number of named styles for the lexer.</p>
+
+    <p><b id="SCI_NAMEOFSTYLE">SCI_NAMEOFSTYLE(int style, char *name) &rarr; int</b><br />
+     Retrieve the name of a style. This is a C preprocessor symbol like "SCE_C_COMMENTDOC".</p>
+
+    <p><b id="SCI_TAGSOFSTYLE">SCI_TAGSOFSTYLE(int style, char *tags) &rarr; int</b><br />
+     Retrieve the tags of a style. This is a space-separated set of words like "comment documentation".</p>
+
+    <p><b id="SCI_DESCRIPTIONOFSTYLE">SCI_DESCRIPTIONOFSTYLE(int style, char *description) &rarr; int</b><br />
+     Retrieve an English-language description of a style which may be suitable for display in a user interface.
+     This looks like "Doc comment: block comments beginning with /** or /*!".</p>
+
     <h2 id="LexerObjects">Lexer Objects</h2>
 
     <p>Lexers are programmed as objects that implement the ILexer interface and that interact
-- 
cgit v1.2.3