add missing

zspitzer · zspitzer · commit 7067bba80625 · 2025-01-17T10:00:34.000+01:00
diff --git a/api/reference/ReferenceImporter.cfc b/api/reference/ReferenceImporter.cfc
@@ -300,7 +300,7 @@ categories:
 				if ( size eq 0 ){
 					if ( len( trim( arguments.content ) ) gt 0 ){
 						request.logger( text="Updating existing zero length file: " & arguments.filePath );
-						exists = true;
+						exists = false;
 						break;
 					} else if ( !arguments.docsOnly ){
 						request.logger(text="Missing content from Lucee: " & arguments.filePath, type="warn");
diff --git a/docs/03.reference/01.functions/empty/_arguments/variable.md b/docs/03.reference/01.functions/empty/_arguments/variable.md
@@ -0,0 +1 @@
+Variable to check
diff --git a/docs/03.reference/01.functions/htmlparse/_arguments/html.md b/docs/03.reference/01.functions/htmlparse/_arguments/html.md
@@ -0,0 +1 @@
+A string or a variable that contains one, with HTML to be parsed
diff --git a/docs/03.reference/01.functions/logallthreads/_arguments/duration.md b/docs/03.reference/01.functions/logallthreads/_arguments/duration.md
@@ -0,0 +1,9 @@
+Total duration (in milliseconds) for which the function will collect thread data.
+
+After this period, logging automatically stops.
+
+Common durations:
+
+- 1000-5000ms: Quick snapshots
+- 10000ms: Standard analysis period
+- 30000ms+: Extended analysis for complex operations
diff --git a/docs/03.reference/01.functions/logallthreads/_arguments/interval.md b/docs/03.reference/01.functions/logallthreads/_arguments/interval.md
@@ -0,0 +1,8 @@
+The time interval (in milliseconds) between stack trace captures. Lower values provide
+more detailed analysis but generate larger log files and may impact performance.
+
+Recommended ranges:
+
+- 1-10ms: Very detailed analysis, higher overhead
+- 10-100ms: Balanced detail and performance
+- 100ms+: Lower detail, minimal performance impact
diff --git a/docs/03.reference/01.functions/logallthreads/_arguments/path.md b/docs/03.reference/01.functions/logallthreads/_arguments/path.md
@@ -0,0 +1,5 @@
+Full file path where the log will be written. The file should have a `.jsonl` extension
+for proper identification as a JSON Lines format file. The function will create the file
+if it doesn't exist, or append to it if it does.
+
+Example: `/var/log/lucee/thread_analysis.jsonl`
diff --git a/docs/03.reference/01.functions/logallthreads/_returnTypeDesc.md b/docs/03.reference/01.functions/logallthreads/_returnTypeDesc.md
diff --git a/docs/03.reference/01.functions/logallthreads/_usageNotes.md b/docs/03.reference/01.functions/logallthreads/_usageNotes.md
diff --git a/docs/03.reference/01.functions/logallthreads/function.md b/docs/03.reference/01.functions/logallthreads/function.md
@@ -0,0 +1,28 @@
+---
+title: logAllThreads
+id: function-logallthreads
+related:
+categories:
+    - system
+    - log
+    - debugging
+    - threads
+    - performance
+    - analysis
+---
+
+Creates detailed thread stack trace logs in JSONL format for performance analysis and debugging.
+This function captures stack traces from all running threads at specified intervals for a given duration.
+It executes asynchronously, returning immediately after starting the logging process, making it ideal
+for analyzing specific code segments by initiating logging just before the target code execution.
+The output format is JSONL (JSON Lines), where each line represents a separate JSON object containing:
+
+- Timestamp offset in milliseconds from 1/1/1970 00:00:00 UTC (Unix 0)
+- Complete stack trace of each thread's current location
+
+This data can be used for:
+
+- Performance bottleneck identification
+- Thread behavior analysis
+- Deadlock detection
+- Resource usage patterns
diff --git a/docs/03.reference/01.functions/lsdateformat/_arguments/mask.md b/docs/03.reference/01.functions/lsdateformat/_arguments/mask.md
@@ -0,0 +1,23 @@
+Characters that show how Lucee displays a date:
+
+- `d`: Day of the month as digits; no leading zero for single-digit days.
+- `dd`: Day of the month as digits; leading zero for single-digit days.
+- `ddd`: Day of the week as a three-letter abbreviation.
+- `dddd`: Day of the week as its full name.
+- `m`: Month as digits; no leading zero for single-digit months.
+- `mm`: Month as digits; leading zero for single-digit months.
+- `mmm`: Month as a three-letter abbreviation.
+- `mmmm`: Month as its full name.
+- `yy`: Year as last two digits; leading zero for years less than 10.
+- `yyyy`: Year represented by four digits.
+- `gg`: Period/era string. Ignored. Reserved. The following masks tell how to format the full date and cannot be combined with other masks:
+- `z`: Time zone in literal format, for example, IST
+- `Z`: Time zone in hours of offset (RFC 822 TimeZone), for example, +0530
+- `X`: Time zone in hours of offset in ISO 8601 format. The following are the three ways of using 'X':
+   - `X`: +05
+   - `XX`: +0530
+   - `XXX`: +5:30
+- `short`: equivalent to m/d/y
+- `medium`: equivalent to mmm d, yyyy
+- `long`: equivalent to mmmm d, yyyy
+- `full`: equivalent to dddd, mmmm d, yyyy
diff --git a/docs/03.reference/01.functions/lsnumberformat/_arguments/mask.md b/docs/03.reference/01.functions/lsnumberformat/_arguments/mask.md
@@ -0,0 +1,12 @@
+Mask that has to be used for formatting number: dollar sign, comma, and dot are mapped to their locale-specific equivalents.
+
+- `_,9` Digit placeholder;
+- `.` decimal point;
+- `0` Pads with zeros;
+- `( )` less than zero, puts parentheses around the mask
+- `+` plus sign before positive number minus before negative
+- `-` a space before positive minus sign before negative
+- `,` Separates every third decimal place with a comma.
+- `L,C` Left-justifies or center-justifies number
+- `$` dollar sign before formatted number.
+- `^` Separates left and right formatting.
diff --git a/docs/03.reference/01.functions/ormevictcollection/_arguments/collectionName.md b/docs/03.reference/01.functions/ormevictcollection/_arguments/collectionName.md
@@ -0,0 +1 @@
+Name of the collection in the component
diff --git a/docs/03.reference/01.functions/ormevictcollection/_arguments/entityName.md b/docs/03.reference/01.functions/ormevictcollection/_arguments/entityName.md
@@ -0,0 +1 @@
+Entity name
diff --git a/docs/03.reference/01.functions/ormevictcollection/_arguments/primaryKey.md b/docs/03.reference/01.functions/ormevictcollection/_arguments/primaryKey.md
@@ -0,0 +1 @@
+Primary key of the collection or association data of the entity
diff --git a/docs/03.reference/01.functions/ormevictentity/_arguments/entityName.md b/docs/03.reference/01.functions/ormevictentity/_arguments/entityName.md
@@ -0,0 +1 @@
+Entity name
diff --git a/docs/03.reference/01.functions/ormevictentity/_arguments/primaryKey.md b/docs/03.reference/01.functions/ormevictentity/_arguments/primaryKey.md
@@ -0,0 +1 @@
+Primary key value of the component
diff --git a/docs/03.reference/01.functions/ormevictqueries/_arguments/cacheName.md b/docs/03.reference/01.functions/ormevictqueries/_arguments/cacheName.md
@@ -0,0 +1 @@
+Name of the cache region that you want to evict
diff --git a/docs/03.reference/01.functions/ormexecutequery/_arguments/paramsOrUnique.md b/docs/03.reference/01.functions/ormexecutequery/_arguments/paramsOrUnique.md
@@ -0,0 +1 @@
+Object parameter for the entity
diff --git a/docs/03.reference/01.functions/ormexecutequery/_arguments/queryOptions.md b/docs/03.reference/01.functions/ormexecutequery/_arguments/queryOptions.md
@@ -0,0 +1 @@
+Options for the query
diff --git a/docs/03.reference/01.functions/ormexecutequery/_arguments/uniqueOrQueryOptions.md b/docs/03.reference/01.functions/ormexecutequery/_arguments/uniqueOrQueryOptions.md
@@ -0,0 +1 @@
+Specifies if the object parameter is unique
diff --git a/docs/03.reference/01.functions/queryaddcolumn/_arguments/array.md b/docs/03.reference/01.functions/queryaddcolumn/_arguments/array.md
@@ -0,0 +1 @@
+Name of an array whose elements populate the new column.
diff --git a/docs/03.reference/01.functions/queryaddcolumn/_arguments/column.md b/docs/03.reference/01.functions/queryaddcolumn/_arguments/column.md
@@ -0,0 +1 @@
+Name of the new column.
diff --git a/docs/03.reference/01.functions/queryaddcolumn/_arguments/datatype_or_array.md b/docs/03.reference/01.functions/queryaddcolumn/_arguments/datatype_or_array.md
@@ -0,0 +1 @@
+Column data type.
diff --git a/docs/03.reference/01.functions/queryclose/_arguments/query.md b/docs/03.reference/01.functions/queryclose/_arguments/query.md
@@ -0,0 +1 @@
+Query object to close.
diff --git a/docs/03.reference/01.functions/querycolumnexists/_arguments/query.md b/docs/03.reference/01.functions/querycolumnexists/_arguments/query.md
@@ -0,0 +1 @@
+Query object to check.
diff --git a/docs/03.reference/01.functions/querycolumnlist/_arguments/query.md b/docs/03.reference/01.functions/querycolumnlist/_arguments/query.md
@@ -0,0 +1 @@
+Query object to get data from.
diff --git a/docs/03.reference/01.functions/queryconvertforgrid/_arguments/page.md b/docs/03.reference/01.functions/queryconvertforgrid/_arguments/page.md
@@ -0,0 +1 @@
+The specific page of query data to be returned.
diff --git a/docs/03.reference/01.functions/queryconvertforgrid/_arguments/pageSize.md b/docs/03.reference/01.functions/queryconvertforgrid/_arguments/pageSize.md
@@ -0,0 +1 @@
+Number of rows of query data on a page.
diff --git a/docs/03.reference/01.functions/querymap/_arguments/resQuery.md b/docs/03.reference/01.functions/querymap/_arguments/resQuery.md
@@ -0,0 +1 @@
+Resulted query.
diff --git a/docs/03.reference/01.functions/queryrowbyindex/_arguments/index.md b/docs/03.reference/01.functions/queryrowbyindex/_arguments/index.md
@@ -0,0 +1 @@
+Name of the index.
diff --git a/docs/03.reference/01.functions/quotedvaluelist/_arguments/delimiter.md b/docs/03.reference/01.functions/quotedvaluelist/_arguments/delimiter.md
@@ -0,0 +1 @@
+Characters that separate list elements. The default value is comma.
diff --git a/docs/03.reference/01.functions/serialize/_arguments/object.md b/docs/03.reference/01.functions/serialize/_arguments/object.md
@@ -0,0 +1 @@
+An object to be serialized.
diff --git a/docs/03.reference/01.functions/soundex/_arguments/str.md b/docs/03.reference/01.functions/soundex/_arguments/str.md
@@ -0,0 +1 @@
+A string or a variable that contains one
diff --git a/docs/03.reference/01.functions/unserializejava/_arguments/string.md b/docs/03.reference/01.functions/unserializejava/_arguments/string.md
@@ -0,0 +1 @@
+A string or a variable that contains one
diff --git a/docs/03.reference/01.functions/valuearray/_arguments/query_column.md b/docs/03.reference/01.functions/valuearray/_arguments/query_column.md
@@ -0,0 +1 @@
+Name of an executed query and column. Separate query name and column name with a period.
diff --git a/docs/03.reference/02.tags/application/_attributes/debuggingdatabase.md b/docs/03.reference/02.tags/application/_attributes/debuggingdatabase.md
@@ -0,0 +1 @@
+Log debugging information from the queries in the request
diff --git a/docs/03.reference/02.tags/application/_attributes/debuggingdump.md b/docs/03.reference/02.tags/application/_attributes/debuggingdump.md
@@ -0,0 +1 @@
+Log debugging information from the dump tag in the request
diff --git a/docs/03.reference/02.tags/application/_attributes/debuggingexception.md b/docs/03.reference/02.tags/application/_attributes/debuggingexception.md
@@ -0,0 +1 @@
+Log debugging information from the exceptions in the request
diff --git a/docs/03.reference/02.tags/application/_attributes/debuggingimplicitaccess.md b/docs/03.reference/02.tags/application/_attributes/debuggingimplicitaccess.md
@@ -0,0 +1 @@
+Log debugging information about unscoped variables accessed in the request
diff --git a/docs/03.reference/02.tags/application/_attributes/debuggingqueryusage.md b/docs/03.reference/02.tags/application/_attributes/debuggingqueryusage.md
@@ -0,0 +1 @@
+Log debugging information about which columns in queries are used the request
diff --git a/docs/03.reference/02.tags/application/_attributes/debuggingtemplate.md b/docs/03.reference/02.tags/application/_attributes/debuggingtemplate.md
@@ -0,0 +1 @@
+Log debugging information about templates used in the request
diff --git a/docs/03.reference/02.tags/application/_attributes/debuggingthread.md b/docs/03.reference/02.tags/application/_attributes/debuggingthread.md
@@ -0,0 +1 @@
+Log debugging information about threads used in the request
diff --git a/docs/03.reference/02.tags/application/_attributes/debuggingtimer.md b/docs/03.reference/02.tags/application/_attributes/debuggingtimer.md
@@ -0,0 +1 @@
+Log debugging information from the timer tag in the request
diff --git a/docs/03.reference/02.tags/application/_attributes/debuggingtracing.md b/docs/03.reference/02.tags/application/_attributes/debuggingtracing.md
@@ -0,0 +1 @@
+Log debugging information from the trace tag in the request
diff --git a/docs/03.reference/02.tags/component/_attributes/alias.md b/docs/03.reference/02.tags/component/_attributes/alias.md
@@ -0,0 +1 @@
+Defines an alternative name or alias for the component, providing flexibility in referencing the component in different contexts.
diff --git a/docs/03.reference/02.tags/component/_attributes/mappedSuperClass.md b/docs/03.reference/02.tags/component/_attributes/mappedSuperClass.md
@@ -0,0 +1 @@
+Indicates whether the component acts as a mapped superclass. A mapped superclass serves as a base class for other components to extend but does not itself represent a database entity.
diff --git a/docs/03.reference/02.tags/mail/_attributes/listener.md b/docs/03.reference/02.tags/mail/_attributes/listener.md
@@ -0,0 +1,26 @@
+Listener for the mail. the listener can have 2 (optional) functions, "before" and "after" that get triggered before and after sending the mail.
+
+The functions get all data about the mail.
+
+Listener is only used when `async` (spoolEnable) is set to true.
+
+This attribute overwrites any mail listener defined in the `application.cfc/cfapplication`.
+
+The "before" function can also modify some data, by returning a struct containing the following keys:
+
+`[ from, to, bcc, cc, replyTo, failTo, subject, charset]`
+
+the listener can be a component looking like this:
+
+```
+component {
+    function before( lastExecution, nextExecution, created, id, type, detail,
+        tries, remainingTries, closed, caller, advanced ){}
+    function after( lastExecution, nextExecution, created, id, type, detail, tries,
+        remainingTries, closed, caller, advanced, passed, exception ){}
+}
+```
+
+a struct looking like this:
+
+`component {before:function(...){}, after:function(...){}}`
diff --git a/docs/03.reference/02.tags/query/_attributes/async.md b/docs/03.reference/02.tags/query/_attributes/async.md
@@ -0,0 +1,3 @@
+If set to `true`, the query is executed asynchronously by the Lucee Task manager,
+
+If set to `false` (default) the query is executed in the same thread that executes the request.
diff --git a/docs/03.reference/02.tags/query/_attributes/listener.md b/docs/03.reference/02.tags/query/_attributes/listener.md
@@ -0,0 +1,33 @@
+Listener for the query.
+
+The listener can have 3 (optional) functions, `before`, `after` and `error` that get triggered before and after executing the query and in case of an exception.
+
+The functions get all data about the query.
+
+This attributes overwrites any query listener defined in the `application.cfc/cfapplication`.
+
+All the functions can also modify all data, by returning a struct containing the keys to overwrite following the same structure as the input coming in the argument scope.
+
+The listener can be a component looking like this:
+
+```
+component {
+    function before( cachedAfter, cachedWithin, columnName, datasource, dbType, debug,
+        maxRows, name, ormOptions, username, password, result,
+        returnType, timeout, timezone, unique, sql, args, params, caller){}
+    function after( result, meta, cachedAfter, cachedWithin, columnName, datasource,
+        dbType, debug, maxRows, name, ormOptions, username, password, result,
+        returnType, timeout, timezone, unique, sql, args, params, caller){}
+    function error(exception, lastExecution, nextExecution, created, id, type, detail,
+        tries, remainingTries, closed, caller, advanced, passed, exception){}
+}
+```
+
+or a struct looking like this:
+
+```
+component {
+    before:function(...){},
+    after:function(...){},
+    error:function(...){}}
+```
diff --git a/docs/03.reference/02.tags/query/_attributes/returntype.md b/docs/03.reference/02.tags/query/_attributes/returntype.md
@@ -1,6 +1,6 @@
-one of the following values:
+One of the following values:
 
-- query: default for all dbtype expect "hql", returns a query object
-- array_of_entity: works only with dbtype "hql" and is also the default value for dbtype "hql"
-- array: converts the query object into an array of structs
-- struct: converts the query object into a struct using the columnKey attribute as a primary key
+- `query`: default for all dbtype expect "hql", returns a query object
+- `array_of_entity`: works only with dbtype "hql" and is also the default value for dbtype "hql"
+- `array`: converts the query object into an array of structs
+- `struct`: returns either a struct of structs where the key is specified by the keyColumn attribute and each value is a struct with a query record, or a single record if keyColumn is not set, where each key is a column name and each value has its corresponding value
diff --git a/docs/03.reference/05.objects/datetime/lsdateformat/_arguments/mask.md b/docs/03.reference/05.objects/datetime/lsdateformat/_arguments/mask.md
@@ -0,0 +1,23 @@
+Characters that show how Lucee displays a date:
+
+- `d`: Day of the month as digits; no leading zero for single-digit days.
+- `dd`: Day of the month as digits; leading zero for single-digit days.
+- `ddd`: Day of the week as a three-letter abbreviation.
+- `dddd`: Day of the week as its full name.
+- `m`: Month as digits; no leading zero for single-digit months.
+- `mm`: Month as digits; leading zero for single-digit months.
+- `mmm`: Month as a three-letter abbreviation.
+- `mmmm`: Month as its full name.
+- `yy`: Year as last two digits; leading zero for years less than 10.
+- `yyyy`: Year represented by four digits.
+- `gg`: Period/era string. Ignored. Reserved. The following masks tell how to format the full date and cannot be combined with other masks:
+- `z`: Time zone in literal format, for example, IST
+- `Z`: Time zone in hours of offset (RFC 822 TimeZone), for example, +0530
+- `X`: Time zone in hours of offset in ISO 8601 format. The following are the three ways of using 'X':
+    - `X`: +05
+    - `XX`: +0530
+    - `XXX`: +5:30
+- `short`: equivalent to m/d/y
+- `medium`: equivalent to mmm d, yyyy
+- `long`: equivalent to mmmm d, yyyy
+- `full`: equivalent to dddd, mmmm d, yyyy
diff --git a/docs/03.reference/05.objects/query/addcolumn/_arguments/array.md b/docs/03.reference/05.objects/query/addcolumn/_arguments/array.md
@@ -0,0 +1 @@
+Name of an array whose elements populate the new column.
diff --git a/docs/03.reference/05.objects/query/addcolumn/_arguments/column.md b/docs/03.reference/05.objects/query/addcolumn/_arguments/column.md
@@ -0,0 +1 @@
+Name of the new column.
diff --git a/docs/03.reference/05.objects/query/addcolumn/_arguments/datatype_or_array.md b/docs/03.reference/05.objects/query/addcolumn/_arguments/datatype_or_array.md
@@ -0,0 +1 @@
+Column data type.
diff --git a/docs/03.reference/05.objects/query/columnarray/_arguments/query.md b/docs/03.reference/05.objects/query/columnarray/_arguments/query.md
@@ -0,0 +1 @@
+Query object to get data from.
diff --git a/docs/03.reference/05.objects/query/columncount/_arguments/query.md b/docs/03.reference/05.objects/query/columncount/_arguments/query.md
@@ -0,0 +1 @@
+Query object to get data from.
diff --git a/docs/03.reference/05.objects/query/columnexists/_arguments/column.md b/docs/03.reference/05.objects/query/columnexists/_arguments/column.md
@@ -0,0 +1 @@
+Name of the column.
diff --git a/docs/03.reference/05.objects/query/columnexists/_arguments/query.md b/docs/03.reference/05.objects/query/columnexists/_arguments/query.md
@@ -0,0 +1 @@
+Query object to check.
diff --git a/docs/03.reference/05.objects/query/columnlist/_arguments/query.md b/docs/03.reference/05.objects/query/columnlist/_arguments/query.md
@@ -0,0 +1 @@
+Query object to get data from.
diff --git a/docs/03.reference/05.objects/query/map/_arguments/resQuery.md b/docs/03.reference/05.objects/query/map/_arguments/resQuery.md
@@ -0,0 +1 @@
+Resulted query.
diff --git a/docs/03.reference/05.objects/query/recordcount/_arguments/query.md b/docs/03.reference/05.objects/query/recordcount/_arguments/query.md
@@ -0,0 +1 @@
+Query object to get data from.
diff --git a/docs/03.reference/05.objects/query/rowdatabyindex/_arguments/index.md b/docs/03.reference/05.objects/query/rowdatabyindex/_arguments/index.md
@@ -0,0 +1 @@
+Name of the index
diff --git a/docs/03.reference/05.objects/string/len/_arguments/string.md b/docs/03.reference/05.objects/string/len/_arguments/string.md
@@ -0,0 +1 @@
+A string or a variable that contains one
diff --git a/docs/03.reference/05.objects/string/removechars/_arguments/count.md b/docs/03.reference/05.objects/string/removechars/_arguments/count.md
@@ -0,0 +1 @@
+Count of characters to be removed.
diff --git a/docs/03.reference/05.objects/string/removechars/_arguments/start.md b/docs/03.reference/05.objects/string/removechars/_arguments/start.md
@@ -0,0 +1 @@
+Start position of search from the left.
diff --git a/docs/03.reference/05.objects/struct/keytranslate/_arguments/struct.md b/docs/03.reference/05.objects/struct/keytranslate/_arguments/struct.md
@@ -0,0 +1 @@
+Structure to translate
diff --git a/docs/03.reference/05.objects/xml/transform/_arguments/xsl.md b/docs/03.reference/05.objects/xml/transform/_arguments/xsl.md
@@ -0,0 +1 @@
+A string containing XSL text
