| | | | |
| Offset 1, 26 lines modified | Offset 1, 26 lines modified |
| 1 | TCode | 1 | TCode |
| 2 | User·Guide | 2 | User·Guide |
| 3 | Tools·for·documenting·Java·programs·in·LATEX | 3 | Tools·for·documenting·Java·programs·in·LATEX |
| 4 | Version:·September·11,·2022 | 4 | Version:·August·10,·2021 |
| | |
| 5 | This·document·describes·facilities·that·help·writing·Java·classes,·together·with·detailed | 5 | This·document·describes·facilities·that·help·writing·Java·classes,·together·with·detailed |
| 6 | documentation·of·their·application·programming·interface·(API),·in·a·single·LATEX·file.·The | 6 | documentation·of·their·application·programming·interface·(API),·in·a·single·LATEX·file.·The |
| 7 | LATEX·package·tcode·offers·special·commands·and·environments·for·typesetting·API·documentation·and·user·guides.·It·permits·one·to·display·certain·parts·of·the·code·(e.g.,·method | 7 | LATEX·package·tcode·offers·special·commands·and·environments·for·typesetting·API·documentation·and·user·guides.·It·permits·one·to·display·certain·parts·of·the·code·(e.g.,·method |
| 8 | headers),·hide·others·(e.g.,·method·bodies·and·private·variables),·and·explain·the·methods, | 8 | headers),·hide·others·(e.g.,·method·bodies·and·private·variables),·and·explain·the·methods, |
| 9 | variables,·etc.,·in·a·uniform·format.·Although·it·is·targeted·to·that·language,·it·works·not | 9 | variables,·etc.,·in·a·uniform·format.·Although·it·is·targeted·to·that·language,·it·works·not |
| 10 | only·for·Java,·but·also·for·other·programming·languages·such·as·C,·C++,·etc.·LATEX·will | 10 | only·for·Java,·but·also·for·other·programming·languages·such·as·C,·C++,·etc.·LATEX·will |
| 11 | produce·the·documentation·as·a·.dvi,·.ps,·or·.pdf·file. | 11 | produce·the·documentation·as·a·.dvi,·.ps,·or·.pdf·file. |
| 12 | A·Perl·script·called·texjava·produces·a·.java·file·by·extracting·the·code·form·the·.tex | 12 | A·Perl·script·called·texjava·produces·a·.java·file·by·extracting·the·code·form·the·.tex |
| 13 | file.·With·the·help·of·LATEX2HTML,·texjava·also·transforms·some·of·the·documentation·into | 13 | file.·With·the·help·of·LATEX2HTML,·texjava·also·transforms·some·of·the·documentation·into |
| 14 | Javadoc·format,·so·that·the·javadoc·program·can·later·produce·HTML·documentation·from | 14 | Javadoc·format,·so·that·the·javadoc·program·can·later·produce·HTML·documentation·from |
| 15 | the·.java·file.·Another·Perl·script·called·javatex·does·the·reverse·transformation,·recovering | 15 | the·.java·file.·Another·Perl·script·called·javatex·does·the·reverse·transformation,·recovering |
| 16 | the·.tex·file·from·the·.java·file. | 16 | the·.tex·file·from·the·.java·file. |
| | |
| 17 | \xcSeptember·11,·2022 | 17 | \xcAugust·10,·2021 |
| | |
| 18 | 1 | 18 | 1 |
| | |
| 19 | 1·INTRODUCTION·1 | 19 | 1·INTRODUCTION·1 |
| | |
| 20 | Introduction | 20 | Introduction |
| | |
| Offset 64, 15 lines modified | Offset 64, 15 lines modified |
| 64 | script·can·process·only·one·.tex·file·at·a·time,·one·may·create·a·Makefile·to·automate·the | 64 | script·can·process·only·one·.tex·file·at·a·time,·one·may·create·a·Makefile·to·automate·the |
| 65 | generation·process·when·dealing·with·many·files. | 65 | generation·process·when·dealing·with·many·files. |
| 66 | The·tcode·package.·To·use·the·commands·of·the·tcode·LATEX·package,·this·one·must·be | 66 | The·tcode·package.·To·use·the·commands·of·the·tcode·LATEX·package,·this·one·must·be |
| 67 | imported·via·the·command | 67 | imported·via·the·command |
| 68 | \usepackage{tcode} | 68 | \usepackage{tcode} |
| 69 | This·command·will·locate·and·load·tcode.sty,·so·this·file·must·be·accessible·in·a·directory | 69 | This·command·will·locate·and·load·tcode.sty,·so·this·file·must·be·accessible·in·a·directory |
| | |
| 70 | \xcSeptember·11,·2022 | 70 | \xcAugust·10,·2021 |
| | |
| 71 | 2·LAYOUT·OF·THE·LATEX·FILES·2 | 71 | 2·LAYOUT·OF·THE·LATEX·FILES·2 |
| | |
| 72 | pointed·to·by·the·TEXINPUTS·environment·variable.·The·tcode·package·requires·the·html | 72 | pointed·to·by·the·TEXINPUTS·environment·variable.·The·tcode·package·requires·the·html |
| 73 | and·alltt·packages·which·should·also·be·locatable·through·the·TEXINPUTS·environment | 73 | and·alltt·packages·which·should·also·be·locatable·through·the·TEXINPUTS·environment |
| 74 | variable. | 74 | variable. |
| 75 | The·code·environment.·The·basic·construct·for·identifying·programming·code·in·the | 75 | The·code·environment.·The·basic·construct·for·identifying·programming·code·in·the |
| Offset 107, 15 lines modified | Offset 107, 15 lines modified |
| 107 | them·from·the·documentation,·while·part·of·the·code·of·each·method·may·already·be·in·a | 107 | them·from·the·documentation,·while·part·of·the·code·of·each·method·may·already·be·in·a |
| 108 | hide·environment·(inside·the·code·environment).·In·this·case,·the·outer·hide·environment | 108 | hide·environment·(inside·the·code·environment).·In·this·case,·the·outer·hide·environment |
| 109 | must·begin·and·end·outside·any·code·environment. | 109 | must·begin·and·end·outside·any·code·environment. |
| 110 | The·hide·environment·has·no·effect·on·the·code·extracted·by·texjava·in·the·sense·that | 110 | The·hide·environment·has·no·effect·on·the·code·extracted·by·texjava·in·the·sense·that |
| 111 | all·hidden·code·goes·to·the·.java·file·anyway.·However,·the·hidden·documentation·will·not | 111 | all·hidden·code·goes·to·the·.java·file·anyway.·However,·the·hidden·documentation·will·not |
| 112 | appear·in·the·HTML·conversion·produced·by·Javadoc. | 112 | appear·in·the·HTML·conversion·produced·by·Javadoc. |
| | |
| 113 | \xcSeptember·11,·2022 | 113 | \xcAugust·10,·2021 |
| | |
| 114 | 2·LAYOUT·OF·THE·LATEX·FILES·3 | 114 | 2·LAYOUT·OF·THE·LATEX·FILES·3 |
| | |
| 115 | No·hiding.·In·case·one·wishes·a·documentation·that·contains·all·the·code,·including·the | 115 | No·hiding.·In·case·one·wishes·a·documentation·that·contains·all·the·code,·including·the |
| 116 | method·implementations·and·other·private·material,·one·can·simply·turn·OFF·the·hiding | 116 | method·implementations·and·other·private·material,·one·can·simply·turn·OFF·the·hiding |
| 117 | mechanism·of·the·hide·environment·with·the·command·\hidefalse.·It·can·be·turned·ON | 117 | mechanism·of·the·hide·environment·with·the·command·\hidefalse.·It·can·be·turned·ON |
| 118 | again·with·the·command·\hidetrue.·However,·turning·the·hide·mechanism·OFF·will·get | 118 | again·with·the·command·\hidetrue.·However,·turning·the·hide·mechanism·OFF·will·get |
| Offset 153, 15 lines modified | Offset 153, 15 lines modified |
| 153 | documentation·block,·i.e.,·should·not·contain·a·code·environment.·Departure·from·that | 153 | documentation·block,·i.e.,·should·not·contain·a·code·environment.·Departure·from·that |
| 154 | rule·could·prevent·LATEX2HTML·from·writing·the·markers·separating·the·blocks·(i.e.,·the | 154 | rule·could·prevent·LATEX2HTML·from·writing·the·markers·separating·the·blocks·(i.e.,·the |
| 155 | fields·and·methods),·and·empty·documentation·blocks·could·then·appear·for·subsequent | 155 | fields·and·methods),·and·empty·documentation·blocks·could·then·appear·for·subsequent |
| 156 | fields·and·methods.·The·script·calls·LATEX2HTML·only·once·for·the·LATEX·file·given·to·it,·so | 156 | fields·and·methods.·The·script·calls·LATEX2HTML·only·once·for·the·LATEX·file·given·to·it,·so |
| 157 | any·modification·of·the·LATEX·parameters·in·one·text·block·could·have·an·impact·on·the | 157 | any·modification·of·the·LATEX·parameters·in·one·text·block·could·have·an·impact·on·the |
| 158 | subsequent·blocks. | 158 | subsequent·blocks. |
| | |
| 159 | \xcSeptember·11,·2022 | 159 | \xcAugust·10,·2021 |
| | |
| 160 | 2·LAYOUT·OF·THE·LATEX·FILES·4 | 160 | 2·LAYOUT·OF·THE·LATEX·FILES·4 |
| | |
| 161 | LATEX-only·and·HTML-only·parts.·Certain·parts·of·the·.tex·files·can·be·intended·only | 161 | LATEX-only·and·HTML-only·parts.·Certain·parts·of·the·.tex·files·can·be·intended·only |
| 162 | for·LATEX,·others·only·for·the·HTML·file.·This·can·be·specified·by·the·usual·commands·and | 162 | for·LATEX,·others·only·for·the·HTML·file.·This·can·be·specified·by·the·usual·commands·and |
| 163 | environments·available·in·the·html·package·(e.g.,·the·latexonly,·htmlonly,·and·rawhtml | 163 | environments·available·in·the·html·package·(e.g.,·the·latexonly,·htmlonly,·and·rawhtml |
| 164 | environments). | 164 | environments). |
| Offset 200, 15 lines modified | Offset 200, 15 lines modified |
| 200 | Indenting·documentation.·The·environments·tab,·tabb,·and·tabbb·have·been·defined | 200 | Indenting·documentation.·The·environments·tab,·tabb,·and·tabbb·have·been·defined |
| 201 | to·indent·the·documentation·and·put·it·in·a·smaller·font.·These·environments·are·normally | 201 | to·indent·the·documentation·and·put·it·in·a·smaller·font.·These·environments·are·normally |
| 202 | used·to·describe·fields·and·methods,·they·are·ignored·by·LATEX2HTML,·and·produce·the | 202 | used·to·describe·fields·and·methods,·they·are·ignored·by·LATEX2HTML,·and·produce·the |
| 203 | following·results: | 203 | following·results: |
| 204 | This·is·a·text·indented·with·tab. | 204 | This·is·a·text·indented·with·tab. |
| 205 | This·text·is·more·indented·because·it·is·in·a·tabb·environment. | 205 | This·text·is·more·indented·because·it·is·in·a·tabb·environment. |
| | |
| 206 | \xcSeptember·11,·2022 | 206 | \xcAugust·10,·2021 |
| | |
| 207 | 2·LAYOUT·OF·THE·LATEX·FILES·5 | 207 | 2·LAYOUT·OF·THE·LATEX·FILES·5 |
| | |
| 208 | This·text·is·still·more·indented·because·it·is·in·a·tabbb·environment. | 208 | This·text·is·still·more·indented·because·it·is·in·a·tabbb·environment. |
| | |
| 209 | Doc-comment·tags·for·javadoc.·The·following·LATEX·commands·are·mapped·by·texjava | 209 | Doc-comment·tags·for·javadoc.·The·following·LATEX·commands·are·mapped·by·texjava |
| 210 | to·the·corresponding·javadoc·doc-comment·tags·which·are·used·to·encode·specific·information | 210 | to·the·corresponding·javadoc·doc-comment·tags·which·are·used·to·encode·specific·information |
| Offset 256, 15 lines modified | Offset 256, 15 lines modified |
| 256 | case,·the·signature·argument·will·be·empty. | 256 | case,·the·signature·argument·will·be·empty. |
| 257 | Examples:·\method{density}{}·and·\method{density}{double}·will·generate·the·density | 257 | Examples:·\method{density}{}·and·\method{density}{double}·will·generate·the·density |
| 258 | label·whereas·\method{density(double)}{}·will·generate·density(double). | 258 | label·whereas·\method{density(double)}{}·will·generate·density(double). |
| | |
| 259 | \externalmethod{package}{class-name}{method-name}{signature} | 259 | \externalmethod{package}{class-name}{method-name}{signature} |
| 260 | Indicates·the·name·of·a·method·in·another·class.·This·is·formatted·in·typed·text·in·the·LATEX | 260 | Indicates·the·name·of·a·method·in·another·class.·This·is·formatted·in·typed·text·in·the·LATEX |
| | |
| 261 | \xcSeptember·11,·2022 | 261 | \xcAugust·10,·2021 |
| | |
| 262 | 2·LAYOUT·OF·THE·LATEX·FILES·6 | 262 | 2·LAYOUT·OF·THE·LATEX·FILES·6 |
| | |
| 263 | document,·and·converted·to·an·hyperlink·in·HTML.·The·package·name,·class·name·and·the | 263 | document,·and·converted·to·an·hyperlink·in·HTML.·The·package·name,·class·name·and·the |
| 264 | signature·will·not·appear·in·the·label·name. | 264 | signature·will·not·appear·in·the·label·name. |
| 265 | Example:·\externalmethod{umontreal.iro.lecuyer.gof}{GofStat}{andersonDarling}{} | 265 | Example:·\externalmethod{umontreal.iro.lecuyer.gof}{GofStat}{andersonDarling}{} |
| 266 | will·typeset·andersonDarling | 266 | will·typeset·andersonDarling |
| Offset 301, 15 lines modified | Offset 301, 15 lines modified |
| 301 | \begin{code} | 301 | \begin{code} |
| 302 | public·Complex·add·(Complex·c)\begin{hide}·{ | 302 | public·Complex·add·(Complex·c)\begin{hide}·{ |
| 303 | realPart·+=·c.realPart; | 303 | realPart·+=·c.realPart; |
| 304 | imagPart·+=·c.realPart; | 304 | imagPart·+=·c.realPart; |
| 305 | return·this; | 305 | return·this; |
| 306 | }\end{hide} | 306 | }\end{hide} |
| | |
| 307 | \xcSeptember·11,·2022 | 307 | \xcAugust·10,·2021 |
| | |
| 308 | 3·RUNNING·TEXJAVA·7 | 308 | 3·RUNNING·TEXJAVA·7 |
| | |
| 309 | \end{code} | 309 | \end{code} |
| 310 | \begin{tabb}·Adds·two·complex·numbers. | 310 | \begin{tabb}·Adds·two·complex·numbers. |
| 311 | \param{c}{The·complex·number·to·add·to·this·one.} | 311 | \param{c}{The·complex·number·to·add·to·this·one.} |
| 312 | \return{This·object,·allowing·to·perform·more·than·one·operation | 312 | \return{This·object,·allowing·to·perform·more·than·one·operation |
| Offset 351, 15 lines modified | Offset 351, 15 lines modified |
| 351 | Here,·texjava.pl·has·to·be·replaced·by·a·path·to·the·script·if·it·is·not·executed·in·the | 351 | Here,·texjava.pl·has·to·be·replaced·by·a·path·to·the·script·if·it·is·not·executed·in·the |
| 352 | tcode·directory.·Its·arguments·and·options·are·as·follows: | 352 | tcode·directory.·Its·arguments·and·options·are·as·follows: |
| 353 | infile | 353 | infile |
| 354 | The·name·of·the·input·file,·which·should·have·the·.tex·extension.·If·the·extension·is·not·given | 354 | The·name·of·the·input·file,·which·should·have·the·.tex·extension.·If·the·extension·is·not·given |
|
Max diff block lines reached; 6447/12436 bytes (51.84%) of diff not shown.
|