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.

Sign up for GitHub

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

prettify java-packages/codesnippet-maven-plugin readme java snippets #8454

Merged
merged 1 commit into from
Oct 18, 2024
Merged

prettify java-packages/codesnippet-maven-plugin readme java snippets #8454

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions packages/java-packages/codesnippet-maven-plugin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ match the reference.
Within working Java code, we have a snippet definition. The string after the `BEGIN:` or `END:` comments is an
identifier that can be referenced from Javadocs or READMEs.

```
```java
public ConfigurationClient createSyncConfigurationClient() {
String connectionString = getConnectionString();
// BEGIN: com.azure.data.applicationconfig.configurationclient.instantiation
Expand All @@ -77,8 +77,9 @@ The above example defines a code snippet of identifier `com.azure.data.applicati

Within a javadoc comment, a snippet is referenced by a matching pair html comments.

```
```java
...
/*
* <p><strong>Instantiating a synchronous Configuration Client</strong></p>
*
* <!-- src_embed com.azure.core.http.rest.pagedflux.instantiation -->
Expand All @@ -94,8 +95,9 @@ public final class ConfigurationClient {
```

After update runs:
```
```java
...
/*
* <p><strong>Instantiating a synchronous Configuration Client</strong></p>
*
* <!-- src_embed com.azure.core.http.rest.pagedflux.instantiation -->
Expand Down