75 lines
2.2 KiB
Markdown
75 lines
2.2 KiB
Markdown
# Reference Documentation
|
|
|
|
Precise technical descriptions of Quagga2's API, configuration, and capabilities. Consult these when you need exact details about how something works.
|
|
|
|
## Core API
|
|
|
|
### [API Documentation](api.md)
|
|
|
|
Complete reference for all Quagga2 methods, callbacks, and events.
|
|
|
|
### [Configuration Options](configuration.md)
|
|
|
|
Detailed documentation of every configuration parameter and its effects.
|
|
|
|
### [Camera Access API](camera-access.md)
|
|
|
|
Methods for controlling camera access, torch/flash, and device enumeration.
|
|
|
|
## Barcode Support
|
|
|
|
### [Supported Barcode Types](readers.md)
|
|
|
|
List of all supported barcode formats with characteristics and use cases.
|
|
|
|
## Compatibility
|
|
|
|
### [Browser Support](browser-support.md)
|
|
|
|
Browser compatibility matrix and required Web APIs.
|
|
|
|
## Development
|
|
|
|
### [Dependencies](dependencies.md)
|
|
|
|
Explanation of all package dependencies - which are bundled vs. dev-only.
|
|
|
|
## Quick Lookup
|
|
|
|
| Need | See |
|
|
|------|-----|
|
|
| Method signatures | [API Documentation](api.md) |
|
|
| Config parameter details | [Configuration Options](configuration.md) |
|
|
| Which browsers work | [Browser Support](browser-support.md) |
|
|
| Which barcodes supported | [Supported Barcode Types](readers.md) |
|
|
| Camera control | [Camera Access API](camera-access.md) |
|
|
| Package versions | [Dependencies](dependencies.md) |
|
|
|
|
## Reading Reference Docs
|
|
|
|
Reference documentation is:
|
|
|
|
- **Information-oriented** - Focuses on describing *what exists*
|
|
- **Accurate** - Every detail matters, kept up-to-date with code
|
|
- **Complete** - Covers all features, even obscure ones
|
|
- **Structured** - Organized for lookup, not linear reading
|
|
|
|
Don't read reference docs cover-to-cover. Instead:
|
|
|
|
1. **Look up** what you need when you need it
|
|
2. **Verify** assumptions about how things work
|
|
3. **Discover** features you didn't know existed
|
|
4. **Confirm** exact method signatures or parameter types
|
|
|
|
## Need Context?
|
|
|
|
Reference docs tell you *what* and *how*, but not *why*:
|
|
|
|
- For **why** something works a certain way → See [Explanation](../explanation/)
|
|
- For **how to use** something in practice → See [How-To Guides](../how-to-guides/)
|
|
- For **learning** from scratch → See [Tutorials](../tutorials/)
|
|
|
|
---
|
|
|
|
[← Back to Documentation Home](../index.md)
|