Skip to content

Commit 1c43505

Browse files
authored
Merge pull request github#5121 from alexet/fix-js-jdoc
Javascript Extractor: Update <tt> tages to <code>
2 parents 475d216 + 8dd5a7e commit 1c43505

39 files changed

+74
-74
lines changed

javascript/extractor/src/com/semmle/js/ast/DeclarationFlags.java

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -88,59 +88,59 @@ public static boolean hasDeclareKeyword(int flags) {
8888
return (flags & declareKeyword) != 0;
8989
}
9090

91-
/** Returns a mask with the computed bit set to the value of <tt>enable</tt>. */
91+
/** Returns a mask with the computed bit set to the value of <code>enable</code>. */
9292
public static int getComputed(boolean enable) {
9393
return enable ? computed : 0;
9494
}
9595

96-
/** Returns a mask with the abstract bit set to the value of <tt>enable</tt>. */
96+
/** Returns a mask with the abstract bit set to the value of <code>enable</code>. */
9797
public static int getAbstract(boolean enable) {
9898
return enable ? abstract_ : 0;
9999
}
100100

101-
/** Returns a mask with the static bit set to the value of <tt>enable</tt>. */
101+
/** Returns a mask with the static bit set to the value of <code>enable</code>. */
102102
public static int getStatic(boolean enable) {
103103
return enable ? static_ : 0;
104104
}
105105

106-
/** Returns a mask with the public bit set to the value of <tt>enable</tt>. */
106+
/** Returns a mask with the public bit set to the value of <code>enable</code>. */
107107
public static int getPublic(boolean enable) {
108108
return enable ? public_ : 0;
109109
}
110110

111-
/** Returns a mask with the readonly bit set to the value of <tt>enable</tt>. */
111+
/** Returns a mask with the readonly bit set to the value of <code>enable</code>. */
112112
public static int getReadonly(boolean enable) {
113113
return enable ? readonly : 0;
114114
}
115115

116-
/** Returns a mask with the private bit set to the value of <tt>enable</tt>. */
116+
/** Returns a mask with the private bit set to the value of <code>enable</code>. */
117117
public static int getPrivate(boolean enable) {
118118
return enable ? private_ : 0;
119119
}
120120

121-
/** Returns a mask with the protected bit set to the value of <tt>enable</tt>. */
121+
/** Returns a mask with the protected bit set to the value of <code>enable</code>. */
122122
public static int getProtected(boolean enable) {
123123
return enable ? protected_ : 0;
124124
}
125125

126-
/** Returns a mask with the optional bit set to the value of <tt>enable</tt>. */
126+
/** Returns a mask with the optional bit set to the value of <code>enable</code>. */
127127
public static int getOptional(boolean enable) {
128128
return enable ? optional : 0;
129129
}
130130

131131
/**
132-
* Returns a mask with the definite assignment assertion bit set to the value of <tt>enable</tt>.
132+
* Returns a mask with the definite assignment assertion bit set to the value of <code>enable</code>.
133133
*/
134134
public static int getDefiniteAssignmentAssertion(boolean enable) {
135135
return enable ? definiteAssignmentAssertion : 0;
136136
}
137137

138-
/** Returns a mask with the declare keyword bit set to the value of <tt>enable</tt>. */
138+
/** Returns a mask with the declare keyword bit set to the value of <code>enable</code>. */
139139
public static int getDeclareKeyword(boolean enable) {
140140
return enable ? declareKeyword : 0;
141141
}
142142

143-
/** Returns true if the <tt>n</tt>th bit is set in <tt>flags</tt>. */
143+
/** Returns true if the <code>n</code>th bit is set in <code>flags</code>. */
144144
public static boolean hasNthFlag(int flags, int n) {
145145
return (flags & (1 << n)) != 0;
146146
}

javascript/extractor/src/com/semmle/js/ast/Literal.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
/**
77
* A literal constant.
88
*
9-
* <p>A <tt>null</tt> literal may occur as a TypeScript type annotation - other literals are always
9+
* <p>A <code>null</code> literal may occur as a TypeScript type annotation - other literals are always
1010
* expressions.
1111
*/
1212
public class Literal extends Expression implements ITypeExpression {

javascript/extractor/src/com/semmle/js/ast/MemberDefinition.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public int getFlags() {
4040
return flags;
4141
}
4242

43-
/** Returns true if this has the <tt>static</tt> modifier. */
43+
/** Returns true if this has the <code>static</code> modifier. */
4444
public boolean isStatic() {
4545
return DeclarationFlags.isStatic(flags);
4646
}
@@ -55,7 +55,7 @@ public boolean isAbstract() {
5555
return DeclarationFlags.isAbstract(flags);
5656
}
5757

58-
/** Returns true if has the <tt>public</tt> modifier (not true for implicitly public members). */
58+
/** Returns true if has the <code>public</code> modifier (not true for implicitly public members). */
5959
public boolean hasPublicKeyword() {
6060
return DeclarationFlags.isPublic(flags);
6161
}
@@ -75,7 +75,7 @@ public boolean hasReadonlyKeyword() {
7575
return DeclarationFlags.isReadonly(flags);
7676
}
7777

78-
/** Returns true if this has the <tt>declare</tt> modifier. */
78+
/** Returns true if this has the <code>declare</code> modifier. */
7979
public boolean hasDeclareKeyword() {
8080
return DeclarationFlags.hasDeclareKeyword(flags);
8181
}

javascript/extractor/src/com/semmle/js/extractor/ASTExtractor.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ public enum IdContext {
253253

254254
/**
255255
* An identifier that refers to a variable from inside a type, i.e. the operand to a
256-
* <tt>typeof</tt> type or left operand to an <tt>is</tt> type.
256+
* <code>typeof</code> type or left operand to an <code>is</code> type.
257257
*
258258
* <p>This is generally treated as a type, except a variable binding will be emitted for it.
259259
*/
@@ -288,7 +288,7 @@ public enum IdContext {
288288
VAR_AND_TYPE_AND_NAMESPACE_DECL,
289289

290290
/**
291-
* An identifier that occurs as part of a named export, such as <tt>export { A }</tt>.
291+
* An identifier that occurs as part of a named export, such as <code>export { A }</code>.
292292
*
293293
* <p>This may refer to a variable, type, and/or a namespace, and will export exactly those that
294294
* can be resolved.
@@ -301,7 +301,7 @@ public enum IdContext {
301301

302302
/**
303303
* An identifier that occurs as a qualified name in a default export expression, such as
304-
* <tt>A</tt> in <tt>export default A.B</tt>.
304+
* <code>A</code> in <code>export default A.B</code>.
305305
*
306306
* <p>This acts like {@link #EXPORT}, except it cannot refer to a type (i.e. it must be a
307307
* variable and/or a namespace).

javascript/extractor/src/com/semmle/js/extractor/AutoBuild.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -722,13 +722,13 @@ public static Path tryRelativize(Path from, Path to) {
722722
}
723723

724724
/**
725-
* Prepares <tt>package.json</tt> files in a virtual source root, and, if enabled,
725+
* Prepares <code>package.json</code> files in a virtual source root, and, if enabled,
726726
* installs dependencies for use by the TypeScript type checker.
727727
* <p>
728728
* Some packages must be downloaded while others exist within the same repo ("monorepos")
729729
* but are not in a location where TypeScript would look for it.
730730
* <p>
731-
* Downloaded packages are intalled under <tt>SCRATCH_DIR</tt>, in a mirrored directory hierarchy
731+
* Downloaded packages are intalled under <code>SCRATCH_DIR</code>, in a mirrored directory hierarchy
732732
* we call the "virtual source root".
733733
* <p>
734734
* Packages that exists within the repo are not downloaded. Since they are part of the main source tree,

javascript/extractor/src/com/semmle/js/extractor/ScopeManager.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ public Scope enterScope(Node scopeNode) {
149149
}
150150

151151
/**
152-
* Enters a scope for a block of form <tt>declare global { ... }</tt>.
152+
* Enters a scope for a block of form <code>declare global { ... }</code>.
153153
*
154154
* <p>Declarations in this block will contribute to the global scope, but references can still be
155155
* resolved in the scope enclosing the declaration itself. The scope itself does not have its own

javascript/extractor/src/com/semmle/js/parser/ParsedProject.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public ParsedProject(File tsConfigFile, Set<File> ownFiles, Set<File> allFiles)
1414
this.allFiles = allFiles;
1515
}
1616

17-
/** Returns the <tt>tsconfig.json</tt> file that defines this project. */
17+
/** Returns the <code>tsconfig.json</code> file that defines this project. */
1818
public File getTsConfigFile() {
1919
return tsConfigFile;
2020
}

javascript/extractor/src/com/semmle/ts/ast/ArrayTypeExpr.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
import com.semmle.js.ast.Visitor;
55

66
/**
7-
* An array type, such as <tt>number[]</tt>, or in general <tt>T[]</tt> where <tt>T</tt> is a type.
7+
* An array type, such as <code>number[]</code>, or in general <code>T[]</code> where <code>T</code> is a type.
88
*/
99
public class ArrayTypeExpr extends TypeExpression {
1010
private final ITypeExpression elementType;

javascript/extractor/src/com/semmle/ts/ast/ConditionalTypeExpr.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import com.semmle.js.ast.SourceLocation;
44
import com.semmle.js.ast.Visitor;
55

6-
/** A conditional type annotation, such as <tt>T extends any[] ? A : B</tt>. */
6+
/** A conditional type annotation, such as <code>T extends any[] ? A : B</code>. */
77
public class ConditionalTypeExpr extends TypeExpression {
88
private ITypeExpression checkType;
99
private ITypeExpression extendsType;

javascript/extractor/src/com/semmle/ts/ast/ExportAsNamespaceDeclaration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
import com.semmle.js.ast.Statement;
66
import com.semmle.js.ast.Visitor;
77

8-
/** A statement of form <tt>export as namespace X</tt> where <tt>X</tt> is an identifier. */
8+
/** A statement of form <code>export as namespace X</code> where <code>X</code> is an identifier. */
99
public class ExportAsNamespaceDeclaration extends Statement {
1010
private Identifier id;
1111

0 commit comments

Comments
 (0)