\documentclass[10pt,a4paper]{article} % Packages \usepackage{fancyhdr} % For header and footer \usepackage{multicol} % Allows multicols in tables \usepackage{tabularx} % Intelligent column widths \usepackage{tabulary} % Used in header and footer \usepackage{hhline} % Border under tables \usepackage{graphicx} % For images \usepackage{xcolor} % For hex colours %\usepackage[utf8x]{inputenc} % For unicode character support \usepackage[T1]{fontenc} % Without this we get weird character replacements \usepackage{colortbl} % For coloured tables \usepackage{setspace} % For line height \usepackage{lastpage} % Needed for total page number \usepackage{seqsplit} % Splits long words. %\usepackage{opensans} % Can't make this work so far. Shame. Would be lovely. \usepackage[normalem]{ulem} % For underlining links % Most of the following are not required for the majority % of cheat sheets but are needed for some symbol support. \usepackage{amsmath} % Symbols \usepackage{MnSymbol} % Symbols \usepackage{wasysym} % Symbols %\usepackage[english,german,french,spanish,italian]{babel} % Languages % Document Info \author{killermonkeys} \pdfinfo{ /Title (closure-jsdoc.pdf) /Creator (Cheatography) /Author (killermonkeys) /Subject (Closure JSDoc Cheat Sheet) } % Lengths and widths \addtolength{\textwidth}{6cm} \addtolength{\textheight}{-1cm} \addtolength{\hoffset}{-3cm} \addtolength{\voffset}{-2cm} \setlength{\tabcolsep}{0.2cm} % Space between columns \setlength{\headsep}{-12pt} % Reduce space between header and content \setlength{\headheight}{85pt} % If less, LaTeX automatically increases it \renewcommand{\footrulewidth}{0pt} % Remove footer line \renewcommand{\headrulewidth}{0pt} % Remove header line \renewcommand{\seqinsert}{\ifmmode\allowbreak\else\-\fi} % Hyphens in seqsplit % This two commands together give roughly % the right line height in the tables \renewcommand{\arraystretch}{1.3} \onehalfspacing % Commands \newcommand{\SetRowColor}[1]{\noalign{\gdef\RowColorName{#1}}\rowcolor{\RowColorName}} % Shortcut for row colour \newcommand{\mymulticolumn}[3]{\multicolumn{#1}{>{\columncolor{\RowColorName}}#2}{#3}} % For coloured multi-cols \newcolumntype{x}[1]{>{\raggedright}p{#1}} % New column types for ragged-right paragraph columns \newcommand{\tn}{\tabularnewline} % Required as custom column type in use % Font and Colours \definecolor{HeadBackground}{HTML}{333333} \definecolor{FootBackground}{HTML}{666666} \definecolor{TextColor}{HTML}{333333} \definecolor{DarkBackground}{HTML}{2C2E36} \definecolor{LightBackground}{HTML}{F8F8F8} \renewcommand{\familydefault}{\sfdefault} \color{TextColor} % Header and Footer \pagestyle{fancy} \fancyhead{} % Set header to blank \fancyfoot{} % Set footer to blank \fancyhead[L]{ \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{C} \SetRowColor{DarkBackground} \vspace{-7pt} {\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\noindent \hspace*{-6pt}\includegraphics[width=5.8cm]{/web/www.cheatography.com/public/images/cheatography_logo.pdf}} } \end{tabulary} \columnbreak \begin{tabulary}{11cm}{L} \vspace{-2pt}\large{\bf{\textcolor{DarkBackground}{\textrm{Closure JSDoc Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{killermonkeys} via \textcolor{DarkBackground}{\uline{cheatography.com/2120/cs/611/}}} \end{tabulary} \end{multicols}} \fancyfoot[L]{ \footnotesize \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{LL} \SetRowColor{FootBackground} \mymulticolumn{2}{p{5.377cm}}{\bf\textcolor{white}{Cheatographer}} \\ \vspace{-2pt}killermonkeys \\ \uline{cheatography.com/killermonkeys} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Published 9th October, 2012.\\ Updated 12th May, 2016.\\ Page {\thepage} of \pageref{LastPage}. \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Sponsor}} \\ \SetRowColor{white} \vspace{-5pt} %\includegraphics[width=48px,height=48px]{dave.jpeg} Measure your website readability!\\ www.readability-score.com \end{tabulary} \end{multicols}} \begin{document} \raggedright \raggedcolumns % Set font size to small. Switch to any value % from this page to resize cheat sheet text: % www.emerson.emory.edu/services/latex/latex_169.html \footnotesize % Small font. \begin{multicols*}{3} \begin{tabularx}{5.377cm}{x{2.23965 cm} x{2.73735 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{JSDoc Tags for Functions}} \tn % Row 0 \SetRowColor{LightBackground} @constructor & Function {\emph{is a constructor (can}} new{\emph{)}} \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} @deprecated & Function {\emph{is deprecated}} \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} @extends \{Type\} & Function {\emph{inherits}} Type \tn % Row Count 6 (+ 2) % Row 3 \SetRowColor{white} @implements \{Type\} & Function {\emph{implements}} Type {\emph{(with}} @constructor{\emph{)}} \tn % Row Count 9 (+ 3) % Row 4 \SetRowColor{LightBackground} @inheritDoc & Function {\emph{has same JSDoc as superclass}} \tn % Row Count 11 (+ 2) % Row 5 \SetRowColor{white} @interface & Function {\emph{is interface (no}} new{\emph{)}} \tn % Row Count 13 (+ 2) % Row 6 \SetRowColor{LightBackground} @nosideeffects & {\emph{Can be removed if return value not used}} \tn % Row Count 15 (+ 2) % Row 7 \SetRowColor{white} @override & Function {\emph{overrides superclass}} \tn % Row Count 17 (+ 2) % Row 8 \SetRowColor{LightBackground} @param \{Type\} varname Description & Function {\emph{takes}} varname {\emph{of}} Type \tn % Row Count 19 (+ 2) % Row 9 \SetRowColor{white} @private & Function {\emph{is private (same file or static/instance members)}} \tn % Row Count 22 (+ 3) % Row 10 \SetRowColor{LightBackground} @protected & Function {\emph{is protected (same file or static/instance of subclasses)}} \tn % Row Count 26 (+ 4) % Row 11 \SetRowColor{white} @return \{Type\} Description & Function {\emph{returns}} Type \tn % Row Count 28 (+ 2) % Row 12 \SetRowColor{LightBackground} @this \{Type\} & {\emph{In}} Function, this {\emph{is}} Type \tn % Row Count 30 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \columnbreak \begin{tabularx}{5.377cm}{x{1.59264 cm} x{3.38436 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{JSDoc Tags for Properties}} \tn % Row 0 \SetRowColor{LightBackground} @const & Property {\emph{is constant}} \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} @define & Property {\emph{can be overridden by compiler}} \tn % Row Count 3 (+ 2) % Row 2 \SetRowColor{LightBackground} @deprecated & Property {\emph{is deprecated}} \tn % Row Count 4 (+ 1) % Row 3 \SetRowColor{white} @enum \{Type\} & Property {\emph{is an enum of}} Type (default number) \tn % Row Count 6 (+ 2) % Row 4 \SetRowColor{LightBackground} @expose & Property {\emph{not optimized by compiler}} \tn % Row Count 8 (+ 2) % Row 5 \SetRowColor{white} @lends \{objectName\} & Keys of object are same as property of other object (see: \seqsplit{http://code.google.com/p/jsdoc-toolkit/wiki/TagLends)} \tn % Row Count 13 (+ 5) % Row 6 \SetRowColor{LightBackground} @private & Property is private \tn % Row Count 14 (+ 1) % Row 7 \SetRowColor{white} @protected & Property is protected \tn % Row Count 15 (+ 1) % Row 8 \SetRowColor{LightBackground} @type \{Type\} & Property is \{Type\} \tn % Row Count 16 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \columnbreak \begin{tabularx}{5.377cm}{x{2.38896 cm} x{2.58804 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{JSDoc Type Definitions}} \tn % Row 0 \SetRowColor{LightBackground} \{boolean\} & True \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} \{number\} & 1 \tn % Row Count 2 (+ 1) % Row 2 \SetRowColor{LightBackground} \{string\} & 'monkey' \tn % Row Count 3 (+ 1) % Row 3 \SetRowColor{white} \{Object\} & \{\} \tn % Row Count 4 (+ 1) % Row 4 \SetRowColor{LightBackground} \{Array\} & {[}{]} \tn % Row Count 5 (+ 1) % Row 5 \SetRowColor{white} \{Window\} & {\emph{defined type}} Window \tn % Row Count 7 (+ 2) % Row 6 \SetRowColor{LightBackground} \{goog.ui.Menu\} & {\emph{defined type}} goog.ui.Menu \tn % Row Count 9 (+ 2) % Row 7 \SetRowColor{white} \{Array.\textless{}string\textgreater{}\} & {[}'a','b','c'{]} \tn % Row Count 10 (+ 1) % Row 8 \SetRowColor{LightBackground} \{Object.\textless{}string, number\textgreater{}\} & \{'a':1, 'b':2\} \tn % Row Count 12 (+ 2) % Row 9 \SetRowColor{white} \{(number|boolean)\} & 1 {\emph{or}} True \tn % Row Count 13 (+ 1) % Row 10 \SetRowColor{LightBackground} \{\{myNum: number, myObject\}\} & Record {\emph{with property}} myNum \{number\} and myObject \{Object\} \tn % Row Count 16 (+ 3) % Row 11 \SetRowColor{white} \{Array.\textless{}\{length\}\textgreater{}\} & Array {\emph{of}} \{Objects\} {\emph{with property}} length \tn % Row Count 19 (+ 3) % Row 12 \SetRowColor{LightBackground} \{?number\} & \{number\} {\emph{or}} null \tn % Row Count 20 (+ 1) % Row 13 \SetRowColor{white} \{!Object\} & \{Object\} {\emph{but never}} null \tn % Row Count 22 (+ 2) % Row 14 \SetRowColor{LightBackground} \{function(string, boolean)\} & Function {\emph{with params and unknown return value}} \tn % Row Count 25 (+ 3) % Row 15 \SetRowColor{white} \{function(): number\} & Function {\emph{returning}} number \tn % Row Count 27 (+ 2) % Row 16 \SetRowColor{LightBackground} \{function(this:goog.ui.Menu, string)\} & Function {\emph{where}} this {\emph{is}} goog.ui.Menu \tn % Row Count 29 (+ 2) % Row 17 \SetRowColor{white} \{function(new:goog.ui.Menu, string)\} & Function {\emph{takes}} string{\emph{, creates new}} goog.ui.Menu \tn % Row Count 32 (+ 3) \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{5.377cm}{x{2.38896 cm} x{2.58804 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{JSDoc Type Definitions (cont)}} \tn % Row 18 \SetRowColor{LightBackground} \{function(string, ...{[}number{]})\} & Function {\emph{takes}} string {\emph{then optional}} number {\emph{s}} \tn % Row Count 3 (+ 3) % Row 19 \SetRowColor{white} @param \{...number\} var\_args & {\emph{Variable number of parameters of type}} number \tn % Row Count 6 (+ 3) % Row 20 \SetRowColor{LightBackground} @param \{number=\} opt\_argument & {\emph{Optional parameter of type}} number \tn % Row Count 8 (+ 2) % Row 21 \SetRowColor{white} \{function(?string=, number=)\} & Function {\emph{with optional parameters}} \tn % Row Count 10 (+ 2) % Row 22 \SetRowColor{LightBackground} \{*\} & Variable can take any type \tn % Row Count 12 (+ 2) % Row 23 \SetRowColor{white} \{?\} & Variable can take any type and don't type check \tn % Row Count 15 (+ 3) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{JSDoc Example}} \tn \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{/** \newline % Row Count 1 (+ 1) * Creates an instance of Circle. \newline % Row Count 2 (+ 1) * \newline % Row Count 3 (+ 1) * @constructor \newline % Row Count 4 (+ 1) * @this \{Circle\} \newline % Row Count 5 (+ 1) * @param \{number\} r The desired radius of the circle. \newline % Row Count 7 (+ 2) */ \newline % Row Count 8 (+ 1) function Circle(r) \{ \newline % Row Count 9 (+ 1) /{\emph{* @private }}/ this.radius = r; \newline % Row Count 10 (+ 1) /{\emph{* @private }}/ this.circumference = 2 {\emph{ Math.PI }} r; \newline % Row Count 12 (+ 2) \} \newline % Row Count 13 (+ 1) /** \newline % Row Count 14 (+ 1) * Creates a new Circle from a diameter. \newline % Row Count 15 (+ 1) * \newline % Row Count 16 (+ 1) * @param \{number\} d The desired diameter of the circle. \newline % Row Count 18 (+ 2) * @return \{Circle\} The new Circle object. \newline % Row Count 19 (+ 1) */ \newline % Row Count 20 (+ 1) Circle.fromDiameter = function (d) \{ \newline % Row Count 21 (+ 1) return new Circle(d / 2); \newline % Row Count 22 (+ 1) \}; \newline % Row Count 23 (+ 1) /** \newline % Row Count 24 (+ 1) * Calculates the circumference of the Circle. \newline % Row Count 25 (+ 1) * \newline % Row Count 26 (+ 1) * @deprecated \newline % Row Count 27 (+ 1) * @this \{Circle\} \newline % Row Count 28 (+ 1) * @return \{number\} The circumference of the circle. \newline % Row Count 30 (+ 2) } \tn \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{JSDoc Example (cont)}} \tn \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{ */ \newline % Row Count 1 (+ 1) \seqsplit{Circle.prototype.calculateCircumference} = function () \{ \newline % Row Count 3 (+ 2) return 2 {\emph{ Math.PI }} this.radius; \newline % Row Count 4 (+ 1) \}; \newline % Row Count 5 (+ 1) /** \newline % Row Count 6 (+ 1) * Returns the pre-computed circumference of the Circle. \newline % Row Count 8 (+ 2) * \newline % Row Count 9 (+ 1) * @this \{Circle\} \newline % Row Count 10 (+ 1) * @return \{number\} The circumference of the circle. \newline % Row Count 12 (+ 2) */ \newline % Row Count 13 (+ 1) \seqsplit{Circle.prototype.getCircumference} = function () \{ \newline % Row Count 14 (+ 1) return this.circumference; \newline % Row Count 15 (+ 1) \}; \newline % Row Count 16 (+ 1) /** \newline % Row Count 17 (+ 1) * Find a String representation of the Circle. \newline % Row Count 18 (+ 1) * \newline % Row Count 19 (+ 1) * @override \newline % Row Count 20 (+ 1) * @this \{Circle\} \newline % Row Count 21 (+ 1) * @return \{string\} Human-readable representation of this Circle. \newline % Row Count 23 (+ 2) */ \newline % Row Count 24 (+ 1) \seqsplit{Circle.prototype.toString} = function () \{ \newline % Row Count 25 (+ 1) return "A Circle object with radius of " + this.radius + "."; \newline % Row Count 27 (+ 2) \};% Row Count 28 (+ 1) } \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}