Skip to content

warn when we encounter an undocumented library #606

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

Merged
merged 1 commit into from
Jun 23, 2015
Merged

warn when we encounter an undocumented library #606

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion lib/markdown_processor.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ String _replaceAllLinks(ModelElement element, String str,
if (link != null) {
buf.write('<a href="$link">$codeRef</a>');
} else {
print("WARNING: $element contains unknown doc reference [$codeRef]");
print(" warning: unresolved doc reference '$codeRef' (in $element)");
buf.write(codeRef);
}
}
Expand Down
9 changes: 7 additions & 2 deletions lib/src/html_generator.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,8 +222,13 @@ class HtmlGeneratorInstance {
void generateLibrary(Package package, Library lib) {
print('generating docs for library ${lib.path}...');

// TODO should we add _this_ to the context and avoid putting stuff
// in the map?
if (!lib.hasDocumentation) {
print(
" warning: library '${lib.name}' has no documentation; consider adding some");
}

// TODO: Should we add _this_ to the context and avoid putting stuff in the
// map?
Map data = {
'package': package,
'library': lib,
Expand Down