Skip to content

[INTERNAL] Enable test for transformApiJson script #813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@
"text-summary"
],
"exclude": [
"lib/processors/jsdoc/lib/**",
"lib/processors/jsdoc/lib/ui5/**",
"lib/processors/jsdoc/lib/createIndexFiles.cjs",
"docs/**",
"jsdocs/**",
"coverage/**",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"$schema-ref":"http://schemas.sap.com/sapui5/designtime/api.json/1.0","version":"1.0.0","library":"library.j","symbols":[{"kind":"namespace","name":"library.j","basename":"j","resource":"library/j/some.js","module":"library/j/some","static":true,"visibility":"public","displayName":"library.j","nodes":[{"name":"library.j.aaa","description":"","href":"api/library.j.aaa"},{"name":"library.j.Foo","description":"<p>My super documentation of this class</p>","href":"api/library.j.Foo"}],"title":"namespace library.j","subTitle":""},{"kind":"class","name":"library.j.aaa","basename":"aaa","resource":"library/j/dependency-es6-2.js","module":"library/j/dependency-es6-2","export":"","static":true,"visibility":"public","since":"1.22","extends":"library.j.a","ui5-metamodel":true,"ui5-metadata":{"properties":[{"name":"MyProp","type":"boolean","defaultValue":false,"group":"undefined","visibility":"public","since":"1.46","description":"<p>MyProp property<br><br><i>Since: 1.46.</i></p>","methods":["getMyProp","setMyProp"]}]},"constructor":{"visibility":"public","parameters":[{"name":"sId","optional":true,"description":"<p>ID for the new control, generated automatically if no ID is given</p>","phoneName":"sId","depth":0,"types":[{"name":"string","linkEnabled":false}],"defaultValue":""},{"name":"mSettings","optional":true,"description":"<p>Initial settings for the new control</p>","phoneName":"mSettings","depth":0,"types":[{"name":"object","linkEnabled":false}],"defaultValue":""}],"description":"<p>Constructor for a new library.j.aaa.</p>","references":[],"codeExample":"<pre>new library.j.aaa(sId?, mSettings?)</pre>"},"methods":[{"name":"library.j.aaa.extend","visibility":"public","static":true,"returnValue":{"type":"function","description":"<p>Created class / constructor function</p>","types":[{"value":"function"}]},"parameters":[{"name":"sClassName","optional":false,"description":"<p>Name of the class being created</p>","types":[{"value":"string"}],"defaultValue":""},{"name":"oClassInfo","optional":true,"description":"<p>Object literal with information about the class</p>","types":[{"value":"object"}],"defaultValue":""},{"name":"FNMetaImpl","optional":true,"description":"<p>Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class</p>","types":[{"value":"function"}],"defaultValue":""}],"description":"<p>Creates a new subclass of class library.j.aaa with name <code>sClassName</code> and enriches it with the information contained in <code>oClassInfo</code>.</p><p><code>oClassInfo</code> might contain the same kind of information as described in <a target=\"_self\" href=\"api/library.j.a#methods/library.j.a.extend\">library.j.a.extend</a>.</p>","href":"api/library.j.aaa#methods/library.j.aaa.extend","code":"<pre>library.j.aaa.extend(sClassName, oClassInfo?, FNMetaImpl?) : function</pre>"},{"name":"library.j.aaa.getMetadata","visibility":"public","static":true,"returnValue":{"type":"sap.ui.base.Metadata","description":"<p>Metadata object describing this class</p>","types":[{"value":"sap.ui.base.Metadata","href":"api/sap.ui.base.Metadata","linkEnabled":true}]},"description":"<p>Returns a metadata object for class library.j.aaa.</p>","href":"api/library.j.aaa#methods/library.j.aaa.getMetadata","code":"<pre>library.j.aaa.getMetadata() : sap.ui.base.Metadata</pre>"},{"name":"getMyProp","visibility":"public","since":"1.46","returnValue":{"type":"boolean","description":"<p>Value of property <code>MyProp</code></p>","types":[{"value":"boolean"}]},"description":"<p>Gets current value of property <a target=\"_self\" href=\"api/library.j.aaa#methods/getMyProp\">MyProp</a>.</p><p>MyProp property</p><p>Default value is <code>false</code>.</p>","href":"api/library.j.aaa#methods/getMyProp","code":"<pre>getMyProp() : boolean</pre>"},{"name":"setMyProp","visibility":"public","since":"1.46","returnValue":{"type":"this","description":"<p>Reference to <code>this</code> in order to allow method chaining</p>","types":[{"value":"this"}]},"parameters":[{"name":"bMyProp","optional":true,"defaultValue":false,"description":"<p>New value for property <code>MyProp</code></p>","types":[{"value":"boolean"}]}],"description":"<p>Sets a new value for property <a target=\"_self\" href=\"api/library.j.aaa#methods/getMyProp\">MyProp</a>.</p><p>MyProp property</p><p>When called with a value of <code>null</code> or <code>undefined</code>, the default value of the property will be restored.</p><p>Default value is <code>false</code>.</p>","href":"api/library.j.aaa#methods/setMyProp","code":"<pre>setMyProp(bMyProp?) : this</pre>"}],"displayName":"library.j.aaa","title":"class library.j.aaa","subTitle":""},{"kind":"class","name":"library.j.Foo","basename":"Foo","resource":"library/j/dependency-es6-1.js","module":"library/j/dependency-es6-1","static":true,"visibility":"public","extends":"library.j.Bar","description":"<p>My super documentation of this class</p>","constructor":{"visibility":"public","references":[],"codeExample":"<pre>new library.j.Foo()</pre>"},"displayName":"library.j.Foo","title":"class library.j.Foo","subTitle":""},{"name":"library","displayName":"library","kind":"namespace","nodes":[{"name":"library.j","description":"","href":"api/library.j"}],"title":"namespace library","subTitle":""}]}
3 changes: 1 addition & 2 deletions test/lib/builder/builder.js
Original file line number Diff line number Diff line change
Expand Up @@ -890,8 +890,7 @@ test.serial("Build library.j with JSDoc build only", async (t) => {
graph.setTaskRepository(taskRepository);
await graph.build({
destPath,
includedTasks: ["generateJsdoc"],
excludedTasks: ["*"]
jsdoc: true
});

const expectedFiles = await findFiles(expectedPath);
Expand Down
Loading