Skip to content

Commit eabf532

Browse files
jason-foxjason-fox
committed
Revert "Release Preparation"
This reverts commit cf07e8c.
1 parent 039ada6 commit eabf532

31 files changed

+50663
-0
lines changed

‎.gitattributes‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
test/** linguist-vendored
2+
3+
process_doxygen.xml linguist-language=Ant-Build-System

‎.github/workflows/ci.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: CI
2+
'on':
3+
push:
4+
branches:
5+
- master
6+
- 'fix/*'
7+
pull_request:
8+
branches:
9+
- master
10+
jobs:
11+
# sonarcloud:
12+
# name: SonarCloud Scan
13+
# runs-on: ubuntu-latest
14+
# steps:
15+
# - name: Git checkout
16+
# uses: actions/checkout@v3
17+
# - name: Use Java 17
18+
# uses: actions/setup-java@v3
19+
# with:
20+
# java-version: 17
21+
# distribution: 'zulu'
22+
# - name: SonarCloud Scan
23+
# uses: jason-fox/sonarcloud-action@master
24+
# env:
25+
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
26+
# SONAR_CLOUD_LOGIN: ${{ secrets.SONAR_CLOUD_LOGIN }}
27+
28+
29+
unit-test:
30+
name: Unit Tests
31+
runs-on: ubuntu-latest
32+
steps:
33+
- name: Git checkout
34+
uses: actions/checkout@v3
35+
- name: Run DITA-OT Unit Test
36+
uses: jason-fox/dita-unit-test-action@master
37+
with:
38+
dita-ot-version: '4.0'
39+
plugin: 'fox.jason.passthrough.doxygen'
40+
env:
41+
COVERALLS_TOKEN: ${{ secrets.COVERALLS_TOKEN }}
42+
- uses: actions/upload-artifact@v3
43+
if: always()
44+
with:
45+
name: test-results
46+
path: test-results.html

‎.gitignore‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
**/out/**
2+
**/temp/**
3+
**/tmp/**
4+
5+
target/
6+
classes/
7+
lib/ant-*.jar
8+
lib/ant-launcher-*.jar
9+
10+
.scannerwork/
11+
12+
*~
13+
.fuse_hidden*
14+
.directory
15+
.Trash-*
16+
.nfs*
17+
*.DS_Store
18+
.AppleDouble
19+
.LSOverride
20+
Icon
21+
._*
22+
.DocumentRevisions-V100
23+
.fseventsd
24+
.Spotlight-V100
25+
.TemporaryItems
26+
.Trashes
27+
.VolumeIcon.icns
28+
.com.apple.timemachine.donotpresent
29+
.AppleDB
30+
.AppleDesktop
31+
Network Trash Folder
32+
Temporary Items
33+
.apdisk

‎src/fox/jason/passthrough/DoxygenReader.java‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
package fox.jason.passthrough;
2+
3+
import java.io.File;
4+
import java.io.IOException;
5+
6+
public class DoxygenReader extends AntTaskFileReader {
7+
8+
public DoxygenReader() {
9+
}
10+
11+
private static final String ANT_FILE = "/../process_doxygen.xml";
12+
13+
@Override
14+
protected String runTarget(File inputFile, String title)
15+
throws IOException {
16+
return executeAntTask(
17+
calculateJarPath(DoxygenReader.class) + ANT_FILE,
18+
inputFile,
19+
title
20+
);
21+
}
22+
}

‎test/bootstrap.xml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2+
<project name="unit-test.bootstrap">
3+
<!--
4+
Local definitions for dita.dir and test.root.dir are required to run
5+
individual tests locally.
6+
-->
7+
<dirname property="test.root.dir" file="${ant.file.unit-test.bootstrap}/.."/>
8+
<property name="dita.dir" location="${test.root.dir}/../.."/>
9+
<!--
10+
Load the unit testing library to make the macros available to the unit-tests
11+
-->
12+
<typedef file="${dita.dir}/plugins/fox.jason.unit-test/resource/antlib.xml"/>
13+
</project>

‎test/codeblock/build.xml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2+
<!--
3+
This file is part of the DITA-OT Doxygen Plug-in project.
4+
See the accompanying LICENSE file for applicable licenses.
5+
-->
6+
<project basedir="." default="unit-test">
7+
<import file="../bootstrap.xml"/>
8+
<description>
9+
Expect that Doxygen codeblocks are generated to DITA
10+
</description>
11+
<target name="unit-test">
12+
<property name="file" value="${basedir}/out/codeblock.xml"/>
13+
<exec-transtype transtype="dita"/>
14+
<xmltask
15+
expandEntityReferences="false"
16+
dest="${file}"
17+
outputter="simple"
18+
source="${file}"
19+
>
20+
<xmlcatalog>
21+
<dtd publicId="-//OASIS//DTD DITA Topic//EN" location="../fake.dtd"/>
22+
</xmlcatalog>
23+
</xmltask>
24+
<compare-output suffix=".xml" result="${file}"/>
25+
</target>
26+
</project>

‎test/codeblock/codeblock.xml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
<?xml version="1.0" standalone="yes"?>
2+
<doxygen version="1.9.5" xml:lang="en-US"><compounddef xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="class_i_o_driver_1_1_i_o_message_logging" kind="class" language="C++" prot="public">
3+
<compoundname>IODriver::IOMessageLogging</compoundname>
4+
<basecompoundref prot="public" virt="non-virtual">QObject</basecompoundref>
5+
<briefdescription>
6+
</briefdescription>
7+
<detaileddescription>
8+
<para>Class used to add a generic logging layer to all drivers and plugins Example: <programlisting><codeline><highlight class="normal">&lt;extensions&gt;</highlight></codeline>
9+
<codeline><highlight class="normal">&lt;/extensions&gt;</highlight></codeline>
10+
</programlisting> Additionally channelId, messageId and messageName is supported. </para>
11+
</detaileddescription>
12+
<inheritancegraph>
13+
<node id="1">
14+
<label>IODriver::IOMessageLogging</label>
15+
<link refid="class_i_o_driver_1_1_i_o_message_logging"/>
16+
<childnode refid="2" relation="public-inheritance">
17+
</childnode>
18+
</node>
19+
<node id="2">
20+
<label>QObject</label>
21+
</node>
22+
</inheritancegraph>
23+
<collaborationgraph>
24+
<node id="1">
25+
<label>IODriver::IOMessageLogging</label>
26+
<link refid="class_i_o_driver_1_1_i_o_message_logging"/>
27+
<childnode refid="2" relation="public-inheritance">
28+
</childnode>
29+
</node>
30+
<node id="2">
31+
<label>QObject</label>
32+
</node>
33+
</collaborationgraph>
34+
<location file="test.cpp" line="11" column="5" bodyfile="test.cpp" bodystart="12" bodyend="13"/>
35+
<listofallmembers>
36+
</listofallmembers>
37+
</compounddef><compounddef xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="namespace_i_o_driver" kind="namespace" language="C++">
38+
<compoundname>IODriver</compoundname>
39+
<innerclass refid="class_i_o_driver_1_1_i_o_message_logging" prot="public">IODriver::IOMessageLogging</innerclass>
40+
<briefdescription>
41+
</briefdescription>
42+
<detaileddescription>
43+
</detaileddescription>
44+
<location file="test.cpp" line="1" column="1"/>
45+
</compounddef><compounddef xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="test_8cpp" kind="file" language="C++">
46+
<compoundname>test.cpp</compoundname>
47+
<innerclass refid="class_i_o_driver_1_1_i_o_message_logging" prot="public">IODriver::IOMessageLogging</innerclass>
48+
<innernamespace refid="namespace_i_o_driver">IODriver</innernamespace>
49+
<briefdescription>
50+
</briefdescription>
51+
<detaileddescription>
52+
</detaileddescription>
53+
<programlisting>
54+
<codeline lineno="1"><highlight class="keyword">namespace<sp/></highlight><highlight class="normal">IODriver</highlight></codeline>
55+
<codeline lineno="2"><highlight class="normal">{</highlight></codeline>
56+
<codeline lineno="11" refid="class_i_o_driver_1_1_i_o_message_logging" refkind="compound"><highlight class="normal"><sp/><sp/><sp/><sp/></highlight><highlight class="keyword">class<sp/></highlight><highlight class="normal"><ref refid="class_i_o_driver_1_1_i_o_message_logging" kindref="compound">IOMessageLogging</ref><sp/>:<sp/></highlight><highlight class="keyword">public</highlight><highlight class="normal"><sp/>QObject</highlight></codeline>
57+
<codeline lineno="12"><highlight class="normal"><sp/><sp/><sp/><sp/>{</highlight></codeline>
58+
<codeline lineno="13"><highlight class="normal"><sp/><sp/><sp/><sp/>}</highlight></codeline>
59+
<codeline lineno="14"><highlight class="normal">}</highlight></codeline>
60+
</programlisting>
61+
<location file="test.cpp"/>
62+
</compounddef></doxygen>

‎test/codeblock/document.ditamap‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE bookmap PUBLIC "-//OASIS//DTD DITA BookMap//EN" "bookmap.dtd">
3+
<bookmap>
4+
<appendices>
5+
<topicmeta>
6+
<navtitle>Appendices</navtitle>
7+
</topicmeta>
8+
<appendix format="dita" href="topic.dita">
9+
<topicref format="doxygen" type="topic" href="codeblock.xml"/>
10+
</appendix>
11+
</appendices>
12+
</bookmap>
13+
14+

‎test/codeblock/expected.xml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2+
3+
<?path2rootmap-uri ./?>
4+
<topic id="sample" props="doxygen" specializations="@props/deliveryTarget">
5+
<title>API Reference</title>
6+
<body>
7+
<section>
8+
<title>Namespaces</title>
9+
<ul>
10+
<li>
11+
<xref format="dita" href="#IODriver" scope="local" type="topic">IODriver</xref>
12+
</li>
13+
</ul>
14+
</section>
15+
</body>
16+
<related-links>
17+
<linkpool>
18+
<link format="dita" href="topic.dita" role="parent" scope="local" type="topic">
19+
<linktext>topic</linktext>
20+
</link>
21+
</linkpool>
22+
</related-links>
23+
<topic id="IODriver" outputclass="package" props="doxygen" specializations="@props/deliveryTarget">
24+
<title>Namespace IODriver</title>
25+
<titlealts>
26+
<navtitle>IODriver</navtitle>
27+
<searchtitle>IODriver</searchtitle>
28+
</titlealts>
29+
<body outputclass="java">
30+
<section outputclass="class_summary">
31+
<title>Class Summary</title>
32+
<ul>
33+
<li>
34+
<xref format="dita" href="#IODriver.IOMessageLogging" scope="local" type="topic">IOMessageLogging</xref>
35+
</li>
36+
</ul>
37+
</section>
38+
</body>
39+
<topic id="IODriver.IOMessageLogging" outputclass="class" props="doxygen" specializations="@props/deliveryTarget">
40+
<title>Class IOMessageLogging</title>
41+
<titlealts>
42+
<navtitle>IOMessageLogging</navtitle>
43+
<searchtitle>IOMessageLogging</searchtitle>
44+
</titlealts>
45+
<body outputclass="cpp">
46+
<codeblock>public class
47+
<b>IOMessageLogging</b>extends
48+
<xref format="dita" href="#QObject" scope="local" type="topic">QObject</xref>
49+
</codeblock>
50+
<p></p>
51+
<p>Class used to add a generic logging layer to all drivers and plugins Example:
52+
<codeblock>&lt;extensions&gt;
53+
&lt;/extensions&gt;</codeblock>Additionally channelId, messageId and messageName is supported.</p>
54+
<section outputclass="methods_summary">
55+
<title>Method Summary</title>
56+
</section>
57+
</body>
58+
</topic>
59+
</topic>
60+
</topic>
61+

‎test/codeblock/topic.dita‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
3+
<topic id="topic">
4+
<title>topic</title>
5+
<body>
6+
<p>
7+
Lorem ipsum dolor sit amet consectetur adipiscing, elit porttitor taciti nostra dis potenti donec, fusce gravida primis metus.
8+
</p>
9+
</body>
10+
</topic>

0 commit comments

Comments
 (0)