Modul:Sandlådan/SM5POR/Diag/dok
Detta är dokumentationssidan för Modul:Sandlådan/SM5POR/Diag
|
This page documents the development version of the Diag module. Since it is intended for an international audience, it is written in English, even as the development currently takes place on Swedish Wikipedia. |
Introduction
[redigera wikitext]Technical reference
[redigera wikitext]Exported functions
[redigera wikitext]diag
[redigera wikitext]diag.diag( frame )
Given the calling module frame
, parses the diag
calling option (if found), sets the module diagnostic level accordingly, and returns its resulting value (possibly unchanged) to the caller.
The diagnostic level default value is 0
.
Diagnostic levels 1
and 2
are not used internally by the Qutil module, but reserved for the calling library or application. The remaining levels are used as follows:
Level | Use |
---|---|
3
|
Selected diagnostic messages are produced, but not displayed. |
4
|
Messages produced on level 3 are displayed. |
5
|
In addition to the level 3-4 production and display of selected diagnostic messages, detailed diagnostic messages are produced in most parts of the code, but not displayed. |
6
|
Messages produced on level 5 are displayed. |
The intention of producing diagnostic messages internally without also showing them is to allow for fine-tuned debugging or optimization procedures, where the performance issue or error condition may be related to the diagnostic code itself.
License
[redigera wikitext]The software module described here, as well as this documentation, is available under CC0 (effectively public domain). To avoid confusion and duplicated work due to multiple forks or versions being distributed simultaneously, you are still both welcome and encouraged to contact the author to discuss potential coordination or cooperation.
Copyright © 2022 Anders Andersson |