Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(227)

Unified Diff: sdk/lib/_internal/pub/lib/src/pubspec.dart

Issue 344493003: Update doc comments to follow style guide. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 6 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: sdk/lib/_internal/pub/lib/src/pubspec.dart
diff --git a/sdk/lib/_internal/pub/lib/src/pubspec.dart b/sdk/lib/_internal/pub/lib/src/pubspec.dart
index 8c29253492e1c754900e84665afdd90622c3ac0a..a5e3b5bc809e0f142823bba0dad23fd80b5ec2ca 100644
--- a/sdk/lib/_internal/pub/lib/src/pubspec.dart
+++ b/sdk/lib/_internal/pub/lib/src/pubspec.dart
@@ -38,8 +38,9 @@ class Pubspec {
/// is unknown or can't be represented by a Uri.
final Uri _location;
- /// All pubspec fields. This includes the fields from which other properties
- /// are derived.
+ /// All pubspec fields.
+ ///
+ /// This includes the fields from which other properties are derived.
final Map fields;
/// The package's name.
@@ -283,10 +284,10 @@ class Pubspec {
}
}
- /// Parses the pubspec stored at [filePath] whose text is [contents]. If the
- /// pubspec doesn't define version for itself, it defaults to [Version.none].
- /// [filePath] may be `null` if the pubspec is not on the user's local
- /// file system.
+ /// Parses the pubspec stored at [filePath] whose text is [contents].
+ ///
+ /// If the pubspec doesn't define a version for itself, it defaults to
+ /// [Version.none].
factory Pubspec.parse(String contents, SourceRegistry sources,
{String expectedName, Uri location}) {
if (contents.trim() == '') return new Pubspec.empty();
@@ -415,8 +416,8 @@ class Pubspec {
() => new VersionConstraint.parse(yaml));
}
- // Make sure the same package doesn't appear as both a regular and dev
- // dependency.
+ /// Makes sure the same package doesn't appear as both a regular and dev
+ /// dependency.
void _checkDependencyOverlap(List<PackageDep> dependencies,
List<PackageDep> devDependencies) {
var dependencyNames = dependencies.map((dep) => dep.name).toSet();
@@ -456,8 +457,9 @@ class Pubspec {
}
}
-/// The environment-related metadata in the pubspec. Corresponds to the data
-/// under the "environment:" key in the pubspec.
+/// The environment-related metadata in the pubspec.
+///
+/// Corresponds to the data under the "environment:" key in the pubspec.
class PubspecEnvironment {
/// The version constraint specifying which SDK versions this package works
/// with.
« no previous file with comments | « sdk/lib/_internal/pub/lib/src/progress.dart ('k') | sdk/lib/_internal/pub/lib/src/solver/backtracking_solver.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698