dox_annotation 1.0.5 dox_annotation: ^1.0.5 copied to clipboard
Dox annotation for dox framework
We analyzed this package 2 days ago, and awarded it 130 pub points (of a possible 160):
0/10 points: Provide a valid pubspec.yaml
The package description is too short.
Add more detail to the description
field of pubspec.yaml
. Use 60 to 180 characters to describe the package, what it does, and its target use case.
5/5 points: Provide a valid README.md
5/5 points: Provide a valid CHANGELOG.md
10/10 points: Use an OSI-approved license
Detected license: MIT
.
0/10 points: 20% or more of the public API has dartdoc comments
0 out of 78 API elements (0.0 %) have documentation comments.
Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API. Document at least 20% of the public API elements.
To highlight public API members missing documentation consider enabling the public_member_api_docs
lint.
Some symbols that are missing documentation: dox_annotation
, dox_annotation.DoxModel
, dox_annotation.DoxModel.DoxModel
, dox_annotation.DoxModel.createdAt
, dox_annotation.DoxModel.primaryKey
.
0/10 points: Package has an example
No example found.
See package layout guidelines on how to add an example.
20/20 points: Supports 5 of 6 possible platforms (iOS, Android, Web, Windows, macOS, Linux)
-
✓ Android
-
✓ iOS
-
✓ Windows
-
✓ Linux
-
✓ macOS
These platforms are not supported:
Package not compatible with platform Web
Because:
package:dox_annotation/dox_annotation.dart
that imports:package:dox_annotation/src/websocket_annotation.dart
that imports:package:dox_annotation/src/core_annotation.dart
that imports:dart:io
0/0 points: WASM compatibility
Package not compatible with runtime wasm
Because:
package:dox_annotation/dox_annotation.dart
that imports:package:dox_annotation/src/websocket_annotation.dart
that imports:package:dox_annotation/src/core_annotation.dart
that imports:dart:io
This package is not compatible with runtime wasm
, and will not be rewarded full points in a future version of the scoring model.
See https://dart.dev/web/wasm for details.
50/50 points: code has no errors, warnings, lints, or formatting issues
10/10 points: All of the package dependencies are supported in the latest version
No dependencies.
To reproduce run dart pub outdated --no-dev-dependencies --up-to-date --no-dependency-overrides
.
10/10 points: Package supports latest stable Dart and Flutter SDKs
20/20 points: Compatible with dependency constraint lower bounds
pub downgrade
does not expose any static analysis error.
Analyzed with Pana 0.22.15
, Dart 3.5.4
.
Check the analysis log for details.