Commit 707a0e0
authored
update comments in log moudule (#632)
### What problem were solved in this pull request?
Issue Number: close #551
Problem:
- The original comment for `Log::operator<<` incorrectly stated that it
"won't output header information" (like function, file, line, etc.).
- However, the actual implementation calls `Log::out()`, which
internally uses `LOG_HEAD` macro to print full header info (timestamp,
PID/TID, context, function, file, line).
This mismatch can mislead users into thinking `operator<<` only writes
raw message content, potentially causing confusion or misuse.
### What is changed and how it works?
Updated the Doxygen-style comment above `Log::operator<<` template
function in `src/common/log/log.h`.
New comment clearly states:
- `operator<<` **does output standard header info** (time, pid/tid, ctx,
func, file, line).
- If user wants to customize or suppress headers, they should use
`output()` / `out()` methods directly.
### Other information
No code logic changed — only comments correction.1 parent 6e8cfaf commit 707a0e0
1 file changed
+5
-4
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
65 | 65 | | |
66 | 66 | | |
67 | 67 | | |
68 | | - | |
69 | | - | |
70 | | - | |
71 | | - | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
72 | 73 | | |
73 | 74 | | |
74 | 75 | | |
| |||
0 commit comments