ZF/jitsi-meet
1
0
Fork 0
mirror of https://gitcode.com/GitHub_Trending/ji/jitsi-meet.git synced 2026-05-14 18:17:47 +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

20
react/features/base/dialog/components/Dialog.native.js
View File

@@ -13,14 +13,14 @@ import styles from './styles';
/**
* The value of the style property {@link _TAG_KEY} which identifies the
* OK/submit button of <tt>Prompt</tt>.
* OK/submit button of {@code Prompt}.
*/
const _SUBMIT_TEXT_TAG_VALUE = '_SUBMIT_TEXT_TAG_VALUE';
/**
* The name of the style property which identifies ancestors of <tt>Prompt</tt>
* The name of the style property which identifies ancestors of {@code Prompt}
* such as its OK/submit button for the purposes of workarounds implemented by
* <tt>Dialog</tt>.
* {@code Dialog}.
*
* XXX The value may trigger a react-native warning in the Debug configuration
* but, unfortunately, I couldn't find a value that wouldn't.
@@ -28,11 +28,11 @@ const _SUBMIT_TEXT_TAG_VALUE = '_SUBMIT_TEXT_TAG_VALUE';
const _TAG_KEY = '_TAG_KEY';
/**
* Implements <tt>AbstractDialog</tt> on react-native using <tt>Prompt</tt>.
* Implements {@code AbstractDialog} on react-native using {@code Prompt}.
*/
class Dialog extends AbstractDialog {
/**
* <tt>AbstractDialog</tt>'s React <tt>Component</tt> prop types.
* {@code AbstractDialog}'s React {@code Component} prop types.
*
* @static
*/
@@ -164,14 +164,14 @@ class Dialog extends AbstractDialog {
}
/**
* Creates a deep clone of a specific <tt>ReactElement</tt> with the results
* Creates a deep clone of a specific {@code ReactElement} with the results
* of calling a specific function on every node of a specific
* <tt>ReactElement</tt> tree.
* {@code ReactElement} tree.
*
* @param {ReactElement} element - The <tt>ReactElement</tt> to clone and
* call the specified <tt>f</tt> on.
* @param {ReactElement} element - The {@code ReactElement} to clone and
* call the specified {@code f} on.
* @param {Function} f - The function to call on every node of the
* <tt>ReactElement</tt> tree represented by the specified <tt>element</tt>.
* {@code ReactElement} tree represented by the specified {@code element}.
* @private
* @returns {ReactElement}
*/