Skip to content

Commit 5c49cee

Browse files
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

File tree

mix.exs

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,19 @@ defmodule Longbridge.MixProject do
4242
extras: ["README.md"],
4343
skip_undefined_reference_warnings_on: [
4444
"README.md",
45-
"lib/longbridge/quote_context.ex"
45+
"lib/longbridge/quote_context.ex",
46+
# References `Longbridge.OAuth.token_path/1` which is @doc false
47+
# (a back-compat shim kept for callers that imported it before
48+
# the public function was moved to FileTokenStorage).
49+
"lib/longbridge/oauth/file_token_storage.ex",
50+
# References `Longbridge.Connection.Session` defdelegates which
51+
# are @doc false (the Session module is internal-only; the
52+
# defdelegate is for clarity in the WSConnection code).
53+
"lib/longbridge/ws_connection.ex",
54+
# References `Longbridge.Application` which is @doc false
55+
# (Application modules are entrypoints, not part of the
56+
# public API).
57+
"lib/longbridge/symbol/store.ex"
4658
]
4759
]
4860
end

0 commit comments

Comments
 (0)