From 76e57bb0da5733042fb2be0c783161dfb40654da Mon Sep 17 00:00:00 2001 From: Neil Date: Wed, 26 Oct 2022 08:09:47 +1100 Subject: Add check for validity of 'seealso' links in documentation. Fix 'seelaso' links. Fix some minor formatting issues. --- doc/ScintillaDoc.html | 55 +++++++++++++++++++++++++-------------------------- 1 file changed, 27 insertions(+), 28 deletions(-) (limited to 'doc') diff --git a/doc/ScintillaDoc.html b/doc/ScintillaDoc.html index f540f9d45..cab6e397c 100644 --- a/doc/ScintillaDoc.html +++ b/doc/ScintillaDoc.html @@ -129,7 +129,7 @@

Scintilla Documentation

-

Last edited 1 October 2022 NH

+

Last edited 26 October 2022 NH

Scintilla 5 has moved the lexers from Scintilla into a new Lexilla project.
@@ -275,7 +275,7 @@ Colours are set using the RGBA format (Red, Green, Blue, Alpha). This is similar to colour but with a byte - of alpha added. They are combined as: + of alpha added. They are combined as: red | (green << 8) | (blue << 16) | (alpha << 24). Fully opaque uses an alpha of 255. @@ -722,7 +722,7 @@ and CHARRANGE, so that older code that treats Scintilla as a RichEdit will work.

In a future release, these types will be deprecated. - SCI_GETTEXTRANGEFULL, Sci_TextRangeFull + SCI_GETTEXTRANGEFULL, Sci_TextRangeFull and Sci_CharacterRangeFull should be used instead.

 typedef long Sci_PositionCR;
@@ -1744,11 +1744,12 @@ struct Sci_TextToFindFull {
     If the text argument is NULL(0) then the length that should be allocated
     to store the entire current line is returned.

 
-    
See also: SCI_GETSELTEXT, SCI_GETLINE, SCI_GETTEXT, SCI_GETSTYLEDTEXT, SCI_GETTEXTRANGE

+    
See also: SCI_GETSELTEXT,
+    SCI_GETLINE,
+    SCI_GETTEXT,
+    SCI_GETSTYLEDTEXT,
+    SCI_GETTEXTRANGE

 
     
SCI_SELECTIONISRECTANGLE → bool

      This returns 1 if the current selection is in rectangle mode, 0 if not.

@@ -4900,7 +4901,7 @@ struct Sci_TextToFindFull {
      
If the call succeeded SCI_GETBIDIRECTIONAL will return the same value otherwise
      SC_BIDIRECTIONAL_DISABLED (0) is returned.
      

-     
Opaque selection drawing (SC_LAYER_BASE)
+     
Opaque selection drawing (SCI_SETSELECTIONLAYER(SC_LAYER_BASE))
      is not supported in bidirectional mode.
      Use SC_LAYER_UNDER_TEXT or SC_LAYER_OVER_TEXT instead. 
      

@@ -5499,10 +5500,10 @@ struct Sci_TextToFindFull {
     
SCI_MARKERADD(line line, int markerNumber) → int

      This message adds marker number markerNumber to a line. The message returns -1 if
     this fails (illegal line number, out of memory) or it returns a marker handle number that
-    identifies the added marker. You can use this returned handle with SCI_MARKERLINEFROMHANDLE to find where a
-    marker is after moving or combining lines and with SCI_MARKERDELETEHANDLE to delete the marker
+    identifies the added marker. You can use this returned handle with
+    SCI_MARKERLINEFROMHANDLE to find where a
+    marker is after moving or combining lines and with
+    SCI_MARKERDELETEHANDLE to delete the marker
     based on its handle. The message does not check the value of markerNumber, nor does it
     check if the line already contains the marker.

 
@@ -5721,7 +5722,7 @@ struct Sci_TextToFindFull {
           A rectangle with rounded corners around the text using translucent drawing with the
               interior usually more transparent than the border. You can use
               SCI_INDICSETALPHA and
-			  SCI_INDICSETOUTLINEALPHA
+              SCI_INDICSETOUTLINEALPHA
               to control the alpha transparency values. The default alpha values are 30 for fill colour and 50 for outline colour.
         
 
@@ -5733,7 +5734,7 @@ struct Sci_TextToFindFull {
           A rectangle around the text using translucent drawing with the
               interior usually more transparent than the border. You can use
               SCI_INDICSETALPHA and
-			  SCI_INDICSETOUTLINEALPHA
+              SCI_INDICSETOUTLINEALPHA
               to control the alpha transparency values. The default alpha values are 30 for fill colour and 50 for outline colour.
               This indicator does not colour the top pixel of the line so that indicators on contiguous lines are visually distinct
               and disconnected.
@@ -5901,7 +5902,7 @@ struct Sci_TextToFindFull {
      On many systems a half pixel value will appear as a fainter line but it allows drawing very thin lines on systems with multiple physical pixels
      per logical pixel.
      Half (logical) pixel lines are available on macOS with 'retina' displays,
-     see SC_SUPPORTS_PIXEL_DIVISIONS.

+     see SCI_SUPPORTSFEATURE(SC_SUPPORTS_PIXEL_DIVISIONS).

 
     
SCI_INDICSETALPHA(int indicator, alpha alpha)

      SCI_INDICGETALPHA(int indicator) → int

@@ -6213,8 +6214,8 @@ struct Sci_TextToFindFull {
      SCI_AUTOCGETAUTOHIDE → bool

      By default, the list is cancelled if there are no viable matches (the user has typed
     characters that no longer match a list entry). If you want to keep displaying the original
-    list, set autoHide to false. This also effects SCI_AUTOCSELECT.

+    list, set autoHide to false. This also effects
+     SCI_AUTOCSELECT.

 
     
SCI_AUTOCSETDROPRESTOFWORD(bool dropRestOfWord)

      SCI_AUTOCGETDROPRESTOFWORD → bool

@@ -7206,7 +7207,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
     
For many applications lexing documents larger than 4GB will be too sluggish so
     SC_DOCUMENTOPTION_STYLES_NONE
     and the null lexer "null" can be used. Another approach is to turn on idle styling with
-    SCI_SETIDLESTYLING.
+    SCI_SETIDLESTYLING.
     

 
     
@@ -7969,7 +7970,7 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
      SCI_GETLAYOUTTHREADS → int

      The time taken to measure text runs on wide lines can be improved by performing the task
      concurrently on multiple threads when
-     SC_SUPPORTS_THREAD_SAFE_MEASURE_WIDTHS
+     SCI_SUPPORTSFEATURE(SC_SUPPORTS_THREAD_SAFE_MEASURE_WIDTHS)
      is available.
      This can be a dramatic improvement - a 4 core processor is often able to reduce text layout time to just over one
      quarter of the single-threaded time.

@@ -8227,8 +8228,8 @@ sptr_t CallScintilla(unsigned int iMessage, uptr_t wParam, sptr_t lParam){
      SCI_SETILEXER allows setting a lexer as an ILexer5*.
      The lexer may be implemented by an application or a shared library such as Lexilla.

 
-    
To test if your lexer assignment worked, use SCI_GETLEXER before and after setting the new lexer to
+    
To test if your lexer assignment worked, use SCI_GETLEXER
+    before and after setting the new lexer to
     see if the lexer number changed.
SCI_GETLEXERLANGUAGE retrieves the name of the lexer.

@@ -8717,10 +8718,8 @@ struct SCNotification {
     form:
     startPos = SCI_GETENDSTYLED()
-    lineNumber = SCI_LINEFROMPOSITION(startPos);
-    startPos = SCI_POSITIONFROMLINE(lineNumber);
+    lineNumber = SCI_LINEFROMPOSITION(startPos);
+    startPos = SCI_POSITIONFROMLINE(lineNumber);
     MyStyleRoutine(startPos, SCNotification.position);
 

 
@@ -9160,8 +9159,8 @@ href="#SCI_POSITIONFROMLINE">SCI_POSITIONFROMLINE(lineNumber);
           
+            SCI_CHANGEINSERTION.
+            No other modifications may be made in this handler.
-- 
cgit v1.2.3



 
     
 
0x100000
 
           Text is about to be inserted. The handler may change the text being inserted by calling
-	  SCI_CHANGEINSERTION.
-	  No other modifications may be made in this handler.
 
           position, length, text