Skip to content

Document DNS Query Options (constructor + getters/setters) in usage docs - #33

Merged
purplepixie merged 1 commit into
masterfrom
copilot/update-website-branch-docs
Sep 6, 2026
Merged

purplepixie merged 1 commit into
masterfrom
copilot/update-website-branch-docs

Conversation

Copilot AI commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

The user documentation lacked coverage of DNSQuery construction options (port, timeout, UDP/TCP, debug flags) and their corresponding getters/setters.

Changes

  • docs/usage.md: added a new "DNS Query Options" section covering:
    • Full constructor signature with default values (port=53, timeout=60, udp=true, debug=false, binarydebug=false)
    • Getter/setter pairs for server, port, timeout, udp, debug, binarydebug
    • connectionException/responseException getter/setter pair (default false), cross-referenced to the existing "Error Handling" section
  • docs/ folder: brought the full GitHub Pages docs tree (unchanged apart from usage.md) onto this branch, since it previously only existed on the website branch and this branch's history is unrelated to it.

Example

$query = new DNSQuery("some.server.com", 5353, 10, false); // TCP, port 5353, 10s timeout

// or change after construction
$query = new DNSQuery("some.server.com");
$query->setPort(5353);
$query->setUdp(false);

Note: docs/ is normally maintained on the separate website branch (unrelated git history, used for GitHub Pages). This PR targets copilot/update-website-branch-docs instead, so the docs/ content will need to be merged/cherry-picked into website separately.

Co-authored-by: purplepixie <1479871+purplepixie@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants