Commit 5c49cee
committed
docs: silence remaining @doc false cross-reference warnings in mix docs
`mix docs` was emitting these warnings:
warning: documentation references function
"Longbridge.OAuth.token_path/1" but it is hidden
warning: documentation references function
"Longbridge.Connection.Session.broadcast/2" but it is hidden
warning: documentation references function
"Longbridge.Connection.Session.cancel_idle_timer/1"
but it is hidden
... 7 more Session.<fn> references in lib/longbridge/ws_connection.ex
warning: documentation references module
"Longbridge.Application" but it is hidden
All 11 references are to @doc false functions/modules:
- Longbridge.OAuth.token_path/1: a back-compat defdelegate kept
for callers that imported it before the public function moved
to FileTokenStorage.
- Longbridge.Connection.Session: an internal GenServer-style
state machine. The defdelegates in WSConnection are for code
clarity (call sites read like Longbridge.WSConnection.<fn>
instead of Longbridge.Connection.Session.<fn>).
- Longbridge.Application: the standard mix.exs Application
callback module. Not part of the public API.
Extend skip_undefined_reference_warnings_on in mix.exs to include
the three offending files. The cross-references are intentional
and accurate — the warning is just because ex_doc refuses to
follow @doc false identifiers.
Verified: `mix docs` now runs clean with no warnings.1 parent 2e1f3d2 commit 5c49cee
1 file changed
Lines changed: 13 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
42 | 42 | | |
43 | 43 | | |
44 | 44 | | |
45 | | - | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
46 | 58 | | |
47 | 59 | | |
48 | 60 | | |
| |||
0 commit comments