Skip to content

Commit 2910ff5

Browse files
committed
Add namespace apidocs for logging projects
1 parent d93edf5 commit 2910ff5

File tree

6 files changed

+54
-0
lines changed

6 files changed

+54
-0
lines changed
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
uid: XenoAtom.Logging.Writers
3+
---
4+
5+
# Summary
6+
Writer namespace extended by the terminal package with terminal-aware sinks and styling configuration types.
7+
8+
# Remarks
9+
In addition to core writers, this namespace includes `TerminalLogWriter` and `TerminalLogControlWriter` for markup-aware terminal output and `LogControl` integration via XenoAtom.Terminal.UI.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
uid: XenoAtom.Logging
3+
---
4+
5+
# Summary
6+
Core logging namespace shared by the runtime and terminal package, including terminal-specific logging extension methods.
7+
8+
# Remarks
9+
When `XenoAtom.Logging.Terminal` is referenced, this namespace is extended with markup-oriented logging helpers (for example `InfoMarkup`, `ErrorMarkup`) on top of the core logging APIs.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
uid: XenoAtom.Logging.Formatters
3+
---
4+
5+
# Summary
6+
Formatter namespace for text and JSON output, including built-in formatter implementations and JSON schema/naming options.
7+
8+
# Remarks
9+
Use these APIs to select or customize message rendering behavior (`StandardLogFormatter`, `CompactLogFormatter`, `DetailedLogFormatter`, `JsonLogFormatter`) depending on sink and ingestion requirements.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
uid: XenoAtom.Logging.Helpers
3+
---
4+
5+
# Summary
6+
Low-level helper namespace used by the logging runtime for high-performance formatting, pooling, and text processing primitives.
7+
8+
# Remarks
9+
This namespace primarily contains implementation-focused utilities that support zero-allocation execution paths in the core runtime and writers.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
uid: XenoAtom.Logging.Writers
3+
---
4+
5+
# Summary
6+
Writer namespace containing sink abstractions and built-in sinks such as stream, file, and JSON file writers.
7+
8+
# Remarks
9+
Configure writer instances in `LogManagerConfig`/`LoggerConfig` to control output routing, rolling/retention policies, failure handling, and encoding behavior.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
uid: XenoAtom.Logging
3+
---
4+
5+
# Summary
6+
Core logging namespace for XenoAtom.Logging, including runtime configuration, logger APIs, levels, scopes, and structured properties.
7+
8+
# Remarks
9+
Use this namespace to initialize `LogManager`, resolve `Logger` instances, and write logs with events/properties/scopes. It also contains source-generation entry points such as `[LogMethod]` and `[LogFormatter]`.

0 commit comments

Comments
 (0)