ZF/jitsi-meet
1
0
Fork 0
mirror of https://gitcode.com/GitHub_Trending/ji/jitsi-meet.git synced 2026-05-22 07:17:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

[RN] Fix documentation comments

Browse Source 
* Javadoc introduced @code as a replacement of <code> and <tt> which is
  better aligned with other javadoc tags such as @link. Use it in the
  Java source code. If we switch to Kotlin, then we'll definitely use
  Markdown.

* There are more uses of @code in the JavaScript source code than <tt>
  so use @code for the sake of consistency. Eventually, I'd rather we
  switch to Markdown because it's easier on my eyes.

* Xcode is plain confused by @code and @link. The Internet says that
  Xcode supports the backquote character to denote the beginning and end
  of a string of characters which should be formatted for display as
  code but it doesn't work for me. <tt> is not rendered at all. So use
  the backquote which is rendered itself. Hopefully, if we switch to
  Markdown, then it'll be common between JavaScript and Objective-C
  source code.
This commit is contained in:
Lyubo Marinov
2017-10-01 01:35:19 -05:00
parent b3cef401f2
commit 4bf19d73fd
58 changed files with 333 additions and 417 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
react/features/mobile/image-cache/functions.js
View File

@@ -1,11 +1,11 @@
import { ImageCache } from './';
/**
* Notifies about the successful download of an <tt>Image</tt> source. The name
* is inspired by <tt>Image</tt>. The downloaded <tt>Image</tt> source is not
* Notifies about the successful download of an {@code Image} source. The name
* is inspired by {@code Image}. The downloaded {@code Image} source is not
* available because (1) I do not know how to get it from {@link ImageCache} and
* (2) we do not need it bellow. The function was explicitly introduced to cut
* down on unnecessary <tt>ImageCache</tt> <tt>observer</tt> instances.
* down on unnecessary {@code ImageCache} {@code observer} instances.
*
* @private
* @returns {void}
@@ -17,12 +17,12 @@ function _onLoad() {
}
/**
* Initiates the retrieval of a specific <tt>Image</tt> source (if it has not
* Initiates the retrieval of a specific {@code Image} source (if it has not
* been initiated already). Due to limitations of {@link ImageCache}, the source
* may have at most one <tt>uri</tt>. The name is inspired by <tt>Image</tt>.
* may have at most one {@code uri}. The name is inspired by {@code Image}.
*
* @param {Object} source - The <tt>Image</tt> source with preferably exactly
* one <tt>uri</tt>.
* @param {Object} source - The {@code Image} source with preferably exactly
* one {@code uri}.
* @public
* @returns {void}
*/