vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2025-09-09 00:59:39 +02:00
Code Issues Releases Wiki Activity

Migrate markdown documentation to javadoc

Browse source 
While markdown is easier to write, Smack's markdown documentation was
never tightly coupled with the source. For example, the markdown
documentation never provided links to the actual Java classes and
methods. This poses the risk that the documentation and the code
diverge over time. Furthermore, javadoc is constantly improving (for
example @snippet annotations) and I expect that one will be able to
write javadoc in markdown.

Fixes SMACK-928.
This commit is contained in:
Florian Schmaus 2023-02-03 09:36:54 +01:00
parent f65cf45b5c
commit c9a9982cef
101 changed files with 4441 additions and 5754 deletions
Download patch file Download diff file Expand all files Collapse all files

4
smack-openpgp/src/main/java/org/jivesoftware/smackx/ox/package-info.java
View file

@ -1,6 +1,6 @@
/**
*
* Copyright 2017 Florian Schmaus, 2018 Paul Schaub.
* Copyright 2017-2023 Florian Schmaus, 2018 Paul Schaub.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -15,6 +15,6 @@
* limitations under the License.
*/
/**
* Smack API for XEP-0373: OpenPGP for XMPP.
* Smack API for XEP-0373: OpenPGP for XMPP. See {@link OpenPgpManager} for more information.
*/
package org.jivesoftware.smackx.ox;

2
smack-openpgp/src/main/java/org/jivesoftware/smackx/ox_im/package-info.java
View file

@ -15,6 +15,6 @@
* limitations under the License.
*/
/**
* Smack API for XEP-0374: OpenPGP for XMPP: Instant Messaging.
* Smack API for XEP-0374: OpenPGP for XMPP: Instant Messaging. See {@link OXInstantMessagingManager} for more details.
*/
package org.jivesoftware.smackx.ox_im;