Skip to content

Commit 1c37ce6

Browse files
committed
transfer parts from the wiki to the dev-manual
1 parent 41fa13a commit 1c37ce6

2 files changed

Lines changed: 23 additions & 0 deletions

File tree

developer-manual/en/chapter02-engine-internals.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,23 @@ Levels: `LOG_DEBUG`, `LOG_INFO`, `LOG_WARNING`, `LOG_ERROR`
170170

171171
Modules can be filtered at runtime via `Log::setModuleLogLevel()`.
172172

173+
===== C++ Logging Macros
174+
175+
When writing C++ code, always use the provided log macros defined in
176+
`engine/core/modules.h`:
177+
178+
[source,cpp]
179+
----
180+
FL_DBG(module, msg) // Debug level
181+
FL_LOG(module, msg) // Informational level
182+
FL_WARN(module, msg) // Warning level
183+
FL_ERR(module, msg) // Error level
184+
FL_PANIC(module, msg) // Panic level (causes abort)
185+
----
186+
187+
Modules are defined in `<FIFE>/engine/core/modules.h`. Always use the correct
188+
log module when writing to the log.
189+
173190
==== XML Settings to EngineSettings
174191

175192
The XML settings file maps directly to `EngineSettings`:

developer-manual/en/chapter04_coding-standards.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
We have a set of quite detailed coding standards that have been followed for some time.
44

5+
=== Input file formats
6+
7+
FIFE's accepted input file format is XML. The XML format should be used when
8+
describing data (metadata). Any new or existing functionality (like font file
9+
definitions) should also use the XML format.
10+
511
include::chapter04-cpp-coding-standard.adoc[]
612

713
include::chapter04-python-coding-standard.adoc[]

0 commit comments

Comments
 (0)