From fc53a08bb0ffaf2bd49408f50701f17cdd603fb9 Mon Sep 17 00:00:00 2001
From: Florian Dold <florian.dold@gmail.com>
Date: Wed, 24 May 2017 15:46:49 +0200
Subject: add some more docs

---
 src/i18n.tsx | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

(limited to 'src/i18n.tsx')

diff --git a/src/i18n.tsx b/src/i18n.tsx
index 656bb3a05..48631afb2 100644
--- a/src/i18n.tsx
+++ b/src/i18n.tsx
@@ -18,6 +18,9 @@
  * Translation helpers for React components and template literals.
  */
 
+/**
+ * Imports.
+ */
 import * as jedLib from "jed";
 import {strings} from "./i18n/strings";
 import * as React from "react";
@@ -102,9 +105,11 @@ interface TranslateProps {
  * in a another non-text element.
  *
  * Example:
+ * ```
  * <Translate>
  * Hello.  Your score is <span><PlayerScore player={player} /></span>
  * </Translate>
+ * ```
  */
 export class Translate extends React.Component<TranslateProps,void> {
   render(): JSX.Element {
@@ -143,10 +148,12 @@ export class Translate extends React.Component<TranslateProps,void> {
  * Should only contain TranslateSingular and TransplatePlural as children.
  *
  * Example:
+ * ```
  * <TranslateSwitch target={n}>
  *  <TranslateSingular>I have {n} apple.</TranslateSingular>
  *  <TranslatePlural>I have {n} apples.</TranslatePlural>
  * </TranslateSwitch>
+ * ```
  */
 export class TranslateSwitch extends React.Component<TranslateSwitchProps,void>{
   render(): JSX.Element {
@@ -181,7 +188,7 @@ interface TranslationPluralProps {
 }
 
 /**
- * @see TranslateSwitch
+ * See [[TranslateSwitch]].
  */
 export class TranslatePlural extends React.Component<TranslationPluralProps,void> {
   render(): JSX.Element {
@@ -213,7 +220,7 @@ export class TranslatePlural extends React.Component<TranslationPluralProps,void
 
 
 /**
- * @see TranslateSwitch
+ * See [[TranslateSwitch]].
  */
 export class TranslateSingular extends React.Component<TranslationPluralProps,void> {
   render(): JSX.Element {
-- 
cgit v1.2.3

