mirror of
https://gitee.com/pnoker/iot-dc3.git
synced 2026-09-19 02:04:37 +08:00
pnoker
1fa2d6f0cf
A comment-health audit driven by an AST scanner (regex scanners kept false-positiving on annotation-separated javadoc; the AST pass with constructor and @Override-implementation exemptions is what produced a trustworthy worklist) ended with a much smaller true gap than the raw numbers suggested: class-level javadoc is already at 100% repository-wide. What actually gets filled here: - AnalyticsModel: all 30 nested records of the S19 analytics facet get maintainer-voice javadoc (the @Schema descriptions serve the API side; these serve code readers). - The whole entity/ext family (29 files, 47 nested classes): every Content/Ui/Validation/Security/AppliesTo/Template/Dedup/... schema class states what it actually holds — read from the fields, not templated. - Adapter families: the @Bean methods of all six MQ adapters, all four TSDB adapters and the three DB dialect adapters get one-line maintainer docs (what binds to what, what is overridable). - Nested support types across data/agentic/constant/public/facade: NotifyBindKey, CacheTuning, Credential, dashboard VOs' Item/BucketVO, ExpireListener (plus its null-doc placeholder javadoc replaced with a real contract), agentic chat/stream VOs' choice/delta/usage shapes, tool-context records, RequestHeader envelopes, FleetSummary, visualization Type/Scale codes. - PointValueSampleConverter's boundary methods now state the port-side contract (quality default injection point, batch order preservation). Comment drift fixed: the class javadoc of the can/mqtt/opc-da driver skeletons claimed "see TODO markers in method bodies" — those markers do not exist; the claims are corrected to plain work-in-progress notes. The genuine TODOs (zigbee API verification, lwm2m lookup, ethernet-ip CIP framing, CAN JNI) stay: they mark real unimplemented behavior. Vendored-code boundary: the opc-da module carries a ported org.openscada library (46 files, package org.openscada.*). Its trivial accessors stay bare on purpose — filler comments on get/set pairs are exactly the kind of noise this pass exists to remove — but the non-obvious JIStruct wire-decoder methods (getStruct/fromStruct FILETIME + three DO wrappers) now document the COM bridge shape. Gates: full-repo compile green; data/model/constant/agentic/public test suites green.
2.8 KiB
2.8 KiB
IoT DC3 Documentation
Most documentation has migrated to the project documentation site. This directory keeps only the source files the release process depends on.
Online documentation
- Documentation site: https://docs.dc3.site/
- Documentation source repository: pnoker/iot-dc3-docs
Files retained in this directory (referenced directly by CI - do not migrate)
| File | Purpose |
|---|---|
TITLE.md |
Release title and summary, assembled into the GitHub Release body by .github/workflows/docker-ci.yml |
CHANGE.md |
Version changelog, written by dc3/bin/changelog.py and assembled into the Release body by docker-ci |
RELEASE-FOOTER.md |
Release quick-start footer (docs links and image pinning), assembled into the Release body by docker-ci |
USAGE.md |
Image usage guide; embedded into the docs site usage page and referenced from the release footer |
DEPLOYMENT.md |
Full deployment runbook (compose scale / swarm / k8s / helm); linked from USAGE.md and snapshotted into the docs site by scripts/sync-external.sh in the docs repository |
The documentation site embeds the changelog
and images & deployment pages from the files above
through VitePress <!--@include:--> syntax, keeping a single source of truth.
Old paths migrated to the documentation site
| Old path | New location |
|---|---|
dc3/doc/QUICKSTART.md |
Quick Start |
dc3/doc/ENVIRONMENT.md |
Environment Variables |
dc3/doc/LOGGING.md |
Logging Conventions |
dc3/doc/TROUBLESHOOTING.md |
Troubleshooting |
dc3/doc/MODULES.md |
Modules & Dependencies |
dc3/doc/DRIVER-AUTHORING.md |
Driver Authoring |
dc3/doc/TESTING.md |
Testing |
If an external link brought you here, please update your bookmark to the new address.