Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancement request: Using @link within @param documentation #1178

Open
dnash21e opened this issue Aug 9, 2023 · 0 comments
Open

Enhancement request: Using @link within @param documentation #1178

dnash21e opened this issue Aug 9, 2023 · 0 comments

Comments

@dnash21e
Copy link

dnash21e commented Aug 9, 2023

The @link works (as long as there is a Data Type for that enum) in the main java doc - but @link does not work when part of the @param documentation

The javadoc for my endpoints is:

/**

  • Get messages in a channel, including any admin redacted messages. Messages are always returned from oldest to latest based on the created
  • date of a message. By default, the latest 5 messages of a channel will be retrieved.
  • You may page through messages in the channel by providing a reference message id and a {@link org.familysearch.chat.api.MessageLogicOperator} for that message.
  • @param streamCid The Stream cid which is a concatenation of the Stream Chat channel type and Stream Chat channel id separated by a colon (":") e.g: fs_direct:z1pz8xx-vr21L9-3262005
  • @param streamMessageId The stream message id used as a reference to start retrieving from. If not provided, the latest message will be used.
  • @param limit The number of messages to retrieve.
  • @param messageLogicOperator Required only when a messageId is provided. A valid {@link org.familysearch.chat.api.MessageLogicOperator} to retrieve relative messages from - based on the reference Stream messageId.
  • @return void
    */

Notice the {@link org.familysearch.chat.api.MessageLogicOperator} in the main java doc and also within the @param messageLogicOperator

This is an image of the generated documentation
generatedEnunciateDocumentation

@stoicflame stoicflame added this to the 2.16.0 milestone Aug 9, 2023
@stoicflame stoicflame removed this from the 2.16.0 milestone Sep 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants