Add JSDoc documentation to useAuth hook for better developer experience

[Copilot]

This PR adds comprehensive JSDoc documentation to the useAuth hook in contexts/AuthContext.tsx to improve developer understanding of the authentication state management functionality.

Changes Made

The useAuth hook now includes detailed JSDoc comments that document:

• Function purpose: Clear description of what the hook provides and its requirements
• Return values: Complete documentation of each property in the returned object:
  • user: Firebase User object or null for authentication state
  • auth: Firebase Auth instance for authentication operations
  • logout: Async function to sign out and clear cached data
  • isSigningOut: Boolean flag indicating sign-out process status
• Error handling: Documents when the hook throws an error (usage outside AuthProvider)
• Usage example: Practical React Native example showing proper implementation

Benefits

• Improves developer experience with clear API documentation
• Reduces onboarding time for new developers working with authentication
• Provides IntelliSense/autocomplete support in modern IDEs
• Documents the authentication flow and state management patterns
• No functional changes - purely documentation enhancement

Example Usage

const { user, logout, isSigningOut } = useAuth();

if (!user) {
  return <Text>Not authenticated</Text>;
}

return (
  <Button 
    title={isSigningOut ? "Signing out..." : "Sign Out"} 
    onPress={logout}
    disabled={isSigningOut}
  />
);

Fixes #380.

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
safe-dose	Ready	Preview	Comment	Sep 15, 2025 4:12pm