Comments (1)
in most code examples, it is not mentioned what include files to use.
There is a link to the complete source code of every non-trivial code example below the example. The relevant headers are also listed at the beginning of every section, and those headers are also links to Reference documentation.
Can you be more specific which examples are lacking this information?
Consider using a tool like doxygen to autogenerate API documentation.
Doxygen is used to generate Reference documentation.
It took me a while searching the sources to figure out that the namespace
src
isn't correct, the correct one isboost::log::sources
.
It's not incorrect, the namespace shorthands used in the documentation are defined here. The shorthands are used to reduce syntactical clutter in the code samples.
I could probably improve exposure of this information by moving it to the front page. This would require restructuring docs though.
Using a settings file was not documented at all.
I had to figure out how to do it based on the example code. There are a lot of strange things in this example that make no sense to me, as I am unfamiliar with the library and its APIs
The example demonstrates how to load the settings file and how adding attributes affect it. All examples are there to demonstrate this or the other feature or use case of the library, and users are free (and even expected) to compile and experiment with examples and see how the library behaves. Understanding what each line does requires one to read the documentation before that, though.
What the heck is pimpl
The term is the link right there in the text.
and why do I care?
Because it affects how attributes behave. It is also important to know if you're going to implement your own attribute. This information is literally what you're asking:
I'm here to understand how the library works.
Here, I was thinking "yes, finally, an explanation of that these things are"... and then it just completely fails again to explain what they are. What does it mean to "generate attribute values"? What are those? Why do I need them?
There is a section with basic term definitions as well as the design overview which are recommended to be read first in the How to read section I mentioned above. These sections give you understanding of how the library operates as a whole. With that understanding, it should be easier to understand the details given in the Detailed feature description.
I can give a few introductory words in the Attributes section that basically duplicate what is written on the pages I linked, but this will be just that - duplication, and it will not relieve the reader from reading those other pages anyway as they are necessary to understand how the library works.
In any case, thank you for your feedback.
from log.
Related Issues (20)
- Boost.Log rotation may throw boost::filesystem::filesystem_error HOT 10
- How to add timezone info for log entries and log filename HOT 3
- Formatting TimeStamp HOT 1
- Boost 1.82, boost\Log\trivial unresolved external symbol error if included after curl HOT 3
- Log Formatting [Conan 2.x, C++20, Boost 1.83] HOT 2
- 1.82.0 compiled for XP uses AcquireSRWLockExclusive HOT 2
- How to append log to same log file after program restarts? HOT 1
- CMake integration for Xcode universal 2 builds HOT 1
- boost日志在动态库里被使用,再次在主程序中使用会崩溃 HOT 1
- Boost stopped printing logs after changing the system time HOT 4
- Redundent call to boost_install() HOT 1
- An infinite loop occurs when boost writes to the log file (Debug Mode, Medium size file) HOT 1
- Consider switching dependency from MPL to MP11 HOT 2
- Linking failure after upgrading boost to 1.82 from 1.69 HOT 2
- advanced instruction sets HOT 1
- About Scope %f HOT 1
- boost/1.85.0 compile issues with msm::front::state_machine_def on llvm/clang++ 18.1.5 with std=c++20 HOT 4
- GetCurrentThreadId is called everytime even not extracting current_thread_id HOT 8
- Crash when FreeLibrary a dll uses Boost.Log HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from log.