Skip to content
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

Support custom md files for package documentation #43201

Merged
merged 3 commits into from
Aug 1, 2024
Merged
Changes from 1 commit
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
Prev Previous commit
Add missing README.mds to langlibs
  • Loading branch information
azinneera committed Aug 1, 2024
commit 00f0129b1ca9253f4c97d69dae7baa0601998c14
Original file line number Diff line number Diff line change
@@ -31,7 +31,6 @@
import io.ballerina.projects.internal.model.BalToolDescriptor;
import io.ballerina.projects.internal.model.CompilerPluginDescriptor;
import io.ballerina.projects.internal.model.Dependency;
import io.ballerina.projects.util.ProjectConstants;
import io.ballerina.projects.util.ProjectUtils;
import io.ballerina.tools.text.TextDocument;
import io.ballerina.tools.text.TextDocuments;
@@ -53,8 +52,8 @@
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
9 changes: 9 additions & 0 deletions langlib/jballerina.java/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
## Module overview

This module provides library operations required for Java interoperability in Ballerina. It includes a set of
Ballerina annotations with which Java constructors, methods, and fields can provide implementations of Ballerina
functions with external function bodies.

For information on the operations, which you can perform with the Java module, see the following learn page.
- [Calling Java Code from Ballerina](https://ballerina.io/learn/user-guide/interoperability/calling-java-code-from-ballerina/)

3 changes: 3 additions & 0 deletions langlib/lang.annotations/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

This module provides predefined annotations and default error type declaration.
3 changes: 3 additions & 0 deletions langlib/lang.array/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.array` module corresponds to the `list` basic type.
3 changes: 3 additions & 0 deletions langlib/lang.boolean/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.boolean` module corresponds to the `boolean` basic type.
3 changes: 3 additions & 0 deletions langlib/lang.decimal/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.decimal` module corresponds to the `decimal` basic type.
3 changes: 3 additions & 0 deletions langlib/lang.error/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.error` module corresponds to the `error` basic type.
3 changes: 3 additions & 0 deletions langlib/lang.float/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.float` module corresponds to the `float` basic type.
3 changes: 3 additions & 0 deletions langlib/lang.function/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.function` module corresponds to the `function` basic type.
3 changes: 3 additions & 0 deletions langlib/lang.future/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.future` module corresponds to the `future` basic type.
3 changes: 3 additions & 0 deletions langlib/lang.int/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.int` module corresponds to the `int` basic type.
3 changes: 3 additions & 0 deletions langlib/lang.map/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.map` module corresponds to the `mapping` basic type.
3 changes: 3 additions & 0 deletions langlib/lang.object/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.object` module corresponds to the `object` basic type.
3 changes: 3 additions & 0 deletions langlib/lang.query/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

This module provides lang library operations on `query-action`s & `query-expression`s.
3 changes: 3 additions & 0 deletions langlib/lang.regexp/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.regexp` module corresponds to the `regexp` basic type.
3 changes: 3 additions & 0 deletions langlib/lang.runtime/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.runtime` module provides functions related to the language runtime that are not specific to a particular basic type.
3 changes: 3 additions & 0 deletions langlib/lang.stream/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.stream` module corresponds to the `stream` basic type.
3 changes: 3 additions & 0 deletions langlib/lang.string/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.string` module corresponds to the `string` basic type.
3 changes: 3 additions & 0 deletions langlib/lang.table/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.table` module corresponds to the `table` basic type.
3 changes: 3 additions & 0 deletions langlib/lang.transaction/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.transaction` module supports transactions.
3 changes: 3 additions & 0 deletions langlib/lang.typedesc/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.typedesc` module corresponds to the `typedesc` basic type.
3 changes: 3 additions & 0 deletions langlib/lang.value/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.value` module provides functions that work on values of more than one basic type.
3 changes: 3 additions & 0 deletions langlib/lang.xml/src/main/ballerina/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## Module overview

The `lang.xml` module corresponds to the `xml` basic type.
Loading