Skip to content

Commit fbb0945

Browse files
jld01jld01
committed
Add LSP C/C++ editor documentation bundle
1 parent c7f134d commit fbb0945

File tree

16 files changed

+291
-8
lines changed

16 files changed

+291
-8
lines changed

‎.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ CONTRIBUTING text
1010
LICENSE text
1111
*.txt text
1212
*.md text
13+
*.adoc text
1314
*.zip binary
1415

1516
# C-like Sources

‎bundles/org.eclipse.cdt.lsp.doc/.asciidoctorconfig.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// support image rendering within the Asciidoctor Editor (#873)
2+
:imagesdir: {asciidoctorconfigdir}/images

‎bundles/org.eclipse.cdt.lsp.doc/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/html/
2+
/workspace/

‎bundles/org.eclipse.cdt.lsp.doc/.project

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>org.eclipse.cdt.lsp.doc</name>
4+
<comment></comment>
5+
<projects>
6+
</projects>
7+
<buildSpec>
8+
<buildCommand>
9+
<name>org.eclipse.pde.ManifestBuilder</name>
10+
<arguments>
11+
</arguments>
12+
</buildCommand>
13+
</buildSpec>
14+
<natures>
15+
<nature>org.eclipse.pde.PluginNature</nature>
16+
</natures>
17+
</projectDescription>

‎bundles/org.eclipse.cdt.lsp.doc/.settings/org.eclipse.core.resources.prefs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
eclipse.preferences.version=1
2+
encoding/<project>=UTF-8

‎bundles/org.eclipse.cdt.lsp.doc/META-INF/MANIFEST.MF

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Manifest-Version: 1.0
2+
Bundle-ManifestVersion: 2
3+
Bundle-Name: %Bundle-Name
4+
Bundle-SymbolicName: org.eclipse.cdt.lsp.doc;singleton:=true
5+
Bundle-Version: 1.0.0.qualifier
6+
Bundle-Vendor: %Bundle-Vendor
7+
Bundle-ActivationPolicy: lazy

‎bundles/org.eclipse.cdt.lsp.doc/OSGI-INF/l10n/bundle.properties

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
###############################################################################
2+
# Copyright (c) 2024 John Dallaway and others.
3+
#
4+
# This program and the accompanying materials
5+
# are made available under the terms of the Eclipse Public License 2.0
6+
# which accompanies this distribution, and is available at
7+
# https://www.eclipse.org/legal/epl-2.0/
8+
#
9+
# SPDX-License-Identifier: EPL-2.0
10+
#
11+
# Contributors:
12+
# John Dallaway - initial implementation (#963)
13+
###############################################################################
14+
Bundle-Name=Language Server based C/C++ Editor Documentation
15+
Bundle-Vendor=Eclipse CDT

‎bundles/org.eclipse.cdt.lsp.doc/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Language Server based C/C++ Editor Documentation
2+
3+
## AsciiDoc content
4+
5+
The Asciidoctor Maven Plugin is configured to generate an HTML file in the `html/` folder for each AsciiDoc source file (`*.adoc`) placed in the `src/asciidoc/` folder.
6+
7+
All AsciiDoc source files should include GitHub rendering support.
8+
9+
During content development, HTML files may be generated by invoking Maven locally:
10+
11+
```
12+
mvn generate-resources
13+
```

‎bundles/org.eclipse.cdt.lsp.doc/about.html

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
4+
<head>
5+
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
6+
<title>About</title>
7+
</head>
8+
9+
<body lang="EN-US">
10+
<h2>About This Content</h2>
11+
12+
<p>November 30, 2017</p>
13+
<h3>License</h3>
14+
15+
<p>
16+
The Eclipse Foundation makes available all content in this plug-in
17+
(&quot;Content&quot;). Unless otherwise indicated below, the Content
18+
is provided to you under the terms and conditions of the Eclipse
19+
Public License Version 2.0 (&quot;EPL&quot;). A copy of the EPL is
20+
available at <a href="https://www.eclipse.org/legal/epl-2.0">https://www.eclipse.org/legal/epl-2.0</a>.
21+
For purposes of the EPL, &quot;Program&quot; will mean the Content.
22+
</p>
23+
24+
<p>
25+
If you did not receive this Content directly from the Eclipse
26+
Foundation, the Content is being redistributed by another party
27+
(&quot;Redistributor&quot;) and different terms and conditions may
28+
apply to your use of any object code in the Content. Check the
29+
Redistributor's license that was provided with the Content. If no such
30+
license exists, contact the Redistributor. Unless otherwise indicated
31+
below, the terms and conditions of the EPL still apply to any source
32+
code in the Content and such source code may be obtained at <a
33+
href="https://www.eclipse.org/">https://www.eclipse.org</a>.
34+
</p>
35+
36+
</body>
37+
38+
</html>

‎bundles/org.eclipse.cdt.lsp.doc/build.properties

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
###############################################################################
2+
# Copyright (c) 2024 John Dallaway and others.
3+
#
4+
# This program and the accompanying materials
5+
# are made available under the terms of the Eclipse Public License 2.0
6+
# which accompanies this distribution, and is available at
7+
# https://www.eclipse.org/legal/epl-2.0/
8+
#
9+
# SPDX-License-Identifier: EPL-2.0
10+
#
11+
# Contributors:
12+
# John Dallaway - initial implementation (#963)
13+
###############################################################################
14+
bin.includes = META-INF/,\
15+
OSGI-INF/,\
16+
.,\
17+
html/,\
18+
help.css,\
19+
toc_editor.xml,\
20+
plugin.xml
21+
src.includes = about.html

0 commit comments

Comments
 (0)