Skip to content

Commit 5b2304e

Browse files
jcollins-gjcollins-g
authored
Fix list markdown not being handled correctly (#1739)
* Fix bullet point rendering * rebuild test package docs
1 parent 7d246ba commit 5b2304e

File tree

111 files changed

+365
-5
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

111 files changed

+365
-5
lines changed

‎lib/src/markdown_processor.dart‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -951,8 +951,6 @@ class Documentation {
951951
return _commentRefs;
952952
}
953953

954-
String get raw => _element.documentation;
955-
956954
void _renderHtmlForDartdoc(bool processAllDocs) {
957955
Tuple3<String, String, bool> renderResults =
958956
_renderMarkdownToHtml(processAllDocs);

‎lib/src/utils.dart‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ String stripCommonWhitespace(String str) {
3636
}
3737

3838
String stripComments(String str) {
39+
bool cStyle = false;
3940
if (str == null) return null;
4041
StringBuffer buf = new StringBuffer();
4142

@@ -53,15 +54,16 @@ String stripComments(String str) {
5354
} else {
5455
if (str.startsWith('/**')) {
5556
str = str.substring(3);
57+
cStyle = true;
5658
}
5759
if (str.endsWith('*/')) {
5860
str = str.substring(0, str.length - 2);
5961
}
6062
str = stripCommonWhitespace(str);
6163
for (String line in str.split('\n')) {
62-
if (line.startsWith('* ')) {
64+
if (cStyle && line.startsWith('* ')) {
6365
buf.write('${line.substring(2)}\n');
64-
} else if (line.startsWith('*')) {
66+
} else if (cStyle && line.startsWith('*')) {
6567
buf.write('${line.substring(1)}\n');
6668
} else {
6769
buf.write('$line\n');

‎test/model_test.dart‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -718,6 +718,7 @@ void main() {
718718
group('Docs as HTML', () {
719719
Class Apple, B, superAwesomeClass, foo2;
720720
TopLevelVariable incorrectDocReferenceFromEx;
721+
TopLevelVariable bulletDoced;
721722
ModelFunction thisIsAsync;
722723
ModelFunction topLevelFunction;
723724

@@ -738,7 +739,8 @@ void main() {
738739
Apple = exLibrary.classes.firstWhere((c) => c.name == 'Apple');
739740
specialList =
740741
fakeLibrary.classes.firstWhere((c) => c.name == 'SpecialList');
741-
742+
bulletDoced =
743+
fakeLibrary.constants.firstWhere((c) => c.name == 'bulletDoced');
742744
topLevelFunction =
743745
fakeLibrary.functions.firstWhere((f) => f.name == 'topLevelFunction');
744746
thisIsAsync =
@@ -1072,6 +1074,10 @@ void main() {
10721074
.allMatches(powers.documentationAsHtml);
10731075
expect(matches, hasLength(1));
10741076
});
1077+
1078+
test('bullet points work in top level variables', () {
1079+
expect(bulletDoced.documentationAsHtml, contains('<li>'));
1080+
});
10751081
});
10761082

10771083
group('Class edge cases', () {

‎test/utils_test.dart‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,13 @@ void main() {
3535
expect(stripComments('///One line.'), equals('One line.'));
3636
});
3737

38+
test('multiple runs with multiline comments', () {
39+
expect(stripComments(stripComments('''
40+
/// A line.
41+
/// * An asterisk
42+
''')), equals('A line.\n* An asterisk'));
43+
});
44+
3845
test('multi-line comment', () {
3946
comment = '''
4047
/// First line.
@@ -93,6 +100,15 @@ void main() {
93100
});
94101

95102
group('/**-style', () {
103+
test('multiple runs with cstyle comments', () {
104+
expect(stripComments(stripComments('''
105+
/**
106+
* A line.
107+
* * An asterisk
108+
*/
109+
''')), equals('A line.\n* An asterisk'));
110+
});
111+
96112
test('one-line comment', () {
97113
expect(stripComments('/** One line. */'), equals('One line.'));
98114
});

‎testing/test_package/lib/fake.dart‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,17 @@ class HasGenerics<X, Y, Z> {
8989
Map<X, Y> convertToMap() => null;
9090
}
9191

92+
/// Bullet point documentation.
93+
///
94+
/// This top level constant has bullet points.
95+
///
96+
/// * A bullet point.
97+
/// * Another even better bullet point.
98+
/// * A bullet point that wraps onto a second line, without creating a new
99+
/// bullet point or paragraph.
100+
/// * A fourth bullet point.
101+
const String bulletDoced = 'Foo bar baz';
102+
92103
/// This class uses a pragma annotation.
93104
@pragma('Hello world')
94105
class HasPragma {}

‎testing/test_package_docs/fake/ABaseClass-class.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ <h5>fake library</h5>
8585
<li><a href="fake/WithGetterAndSetter-class.html">WithGetterAndSetter</a></li>
8686

8787
<li class="section-title"><a href="fake/fake-library.html#constants">Constants</a></li>
88+
<li><a href="fake/bulletDoced-constant.html">bulletDoced</a></li>
8889
<li><a href="fake/CUSTOM_CLASS-constant.html">CUSTOM_CLASS</a></li>
8990
<li><a href="fake/CUSTOM_CLASS_PRIVATE-constant.html">CUSTOM_CLASS_PRIVATE</a></li>
9091
<li><a class="deprecated" href="fake/DOWN-constant.html">DOWN</a></li>

‎testing/test_package_docs/fake/AClassUsingASuperMixin-class.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ <h5>fake library</h5>
8585
<li><a href="fake/WithGetterAndSetter-class.html">WithGetterAndSetter</a></li>
8686

8787
<li class="section-title"><a href="fake/fake-library.html#constants">Constants</a></li>
88+
<li><a href="fake/bulletDoced-constant.html">bulletDoced</a></li>
8889
<li><a href="fake/CUSTOM_CLASS-constant.html">CUSTOM_CLASS</a></li>
8990
<li><a href="fake/CUSTOM_CLASS_PRIVATE-constant.html">CUSTOM_CLASS_PRIVATE</a></li>
9091
<li><a class="deprecated" href="fake/DOWN-constant.html">DOWN</a></li>

‎testing/test_package_docs/fake/AClassWithFancyProperties-class.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ <h5>fake library</h5>
8585
<li><a href="fake/WithGetterAndSetter-class.html">WithGetterAndSetter</a></li>
8686

8787
<li class="section-title"><a href="fake/fake-library.html#constants">Constants</a></li>
88+
<li><a href="fake/bulletDoced-constant.html">bulletDoced</a></li>
8889
<li><a href="fake/CUSTOM_CLASS-constant.html">CUSTOM_CLASS</a></li>
8990
<li><a href="fake/CUSTOM_CLASS_PRIVATE-constant.html">CUSTOM_CLASS_PRIVATE</a></li>
9091
<li><a class="deprecated" href="fake/DOWN-constant.html">DOWN</a></li>

‎testing/test_package_docs/fake/AMixinCallingSuper-class.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ <h5>fake library</h5>
8585
<li><a href="fake/WithGetterAndSetter-class.html">WithGetterAndSetter</a></li>
8686

8787
<li class="section-title"><a href="fake/fake-library.html#constants">Constants</a></li>
88+
<li><a href="fake/bulletDoced-constant.html">bulletDoced</a></li>
8889
<li><a href="fake/CUSTOM_CLASS-constant.html">CUSTOM_CLASS</a></li>
8990
<li><a href="fake/CUSTOM_CLASS_PRIVATE-constant.html">CUSTOM_CLASS_PRIVATE</a></li>
9091
<li><a class="deprecated" href="fake/DOWN-constant.html">DOWN</a></li>

‎testing/test_package_docs/fake/ATypeTakingClass-class.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ <h5>fake library</h5>
8585
<li><a href="fake/WithGetterAndSetter-class.html">WithGetterAndSetter</a></li>
8686

8787
<li class="section-title"><a href="fake/fake-library.html#constants">Constants</a></li>
88+
<li><a href="fake/bulletDoced-constant.html">bulletDoced</a></li>
8889
<li><a href="fake/CUSTOM_CLASS-constant.html">CUSTOM_CLASS</a></li>
8990
<li><a href="fake/CUSTOM_CLASS_PRIVATE-constant.html">CUSTOM_CLASS_PRIVATE</a></li>
9091
<li><a class="deprecated" href="fake/DOWN-constant.html">DOWN</a></li>

0 commit comments

Comments
 (0)