docs: add @moduledoc to all LiveView modules
Add comprehensive module documentation to 12 LiveView modules covering member, user, property, and property_type management views.
This commit is contained in:
parent
409bc7bf2f
commit
ca84633641
12 changed files with 308 additions and 0 deletions
|
|
@ -1,4 +1,36 @@
|
|||
defmodule MvWeb.UserLive.Form do
|
||||
@moduledoc """
|
||||
LiveView form for creating and editing users.
|
||||
|
||||
## Features
|
||||
- Create new users with email
|
||||
- Edit existing user details
|
||||
- Optional password setting (checkbox to toggle)
|
||||
- Link/unlink member accounts
|
||||
- Email synchronization with linked members
|
||||
|
||||
## Form Fields
|
||||
**Required:**
|
||||
- email
|
||||
|
||||
**Optional:**
|
||||
- password (for password authentication strategy)
|
||||
- linked member (select from existing members)
|
||||
|
||||
## Password Management
|
||||
- New users: Can optionally set password with confirmation
|
||||
- Existing users: Can change password (no confirmation required, admin action)
|
||||
- Checkbox toggles password section visibility
|
||||
|
||||
## Member Linking
|
||||
Users can be linked to existing member accounts. When linked, emails are
|
||||
synchronized bidirectionally with User.email as the source of truth.
|
||||
|
||||
## Events
|
||||
- `validate` - Real-time form validation
|
||||
- `save` - Submit form (create or update user)
|
||||
- `toggle_password_section` - Show/hide password fields
|
||||
"""
|
||||
use MvWeb, :live_view
|
||||
|
||||
@impl true
|
||||
|
|
|
|||
|
|
@ -1,4 +1,25 @@
|
|||
defmodule MvWeb.UserLive.Index do
|
||||
@moduledoc """
|
||||
LiveView for displaying and managing the user list.
|
||||
|
||||
## Features
|
||||
- List all users with email and linked member
|
||||
- Sort users by email (default)
|
||||
- Delete users
|
||||
- Navigate to user details and edit forms
|
||||
- Bulk selection for future batch operations
|
||||
|
||||
## Relationships
|
||||
Displays linked member information when a user is connected to a member account.
|
||||
|
||||
## Events
|
||||
- `delete` - Remove a user from the database
|
||||
- `select_user` - Toggle individual user selection
|
||||
- `select_all` - Toggle selection of all visible users
|
||||
|
||||
## Security
|
||||
User deletion requires admin permissions (enforced by Ash policies).
|
||||
"""
|
||||
use MvWeb, :live_view
|
||||
import MvWeb.TableComponents
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,29 @@
|
|||
defmodule MvWeb.UserLive.Show do
|
||||
@moduledoc """
|
||||
LiveView for displaying a single user's details.
|
||||
|
||||
## Features
|
||||
- Display user information (email, OIDC ID)
|
||||
- Show authentication methods (password, OIDC)
|
||||
- Display linked member account (if exists)
|
||||
- Navigate to edit form
|
||||
- Return to user list
|
||||
|
||||
## Displayed Information
|
||||
- Email address
|
||||
- OIDC ID (if authenticated via OIDC)
|
||||
- Password authentication status
|
||||
- Linked member (name and email)
|
||||
|
||||
## Authentication Status
|
||||
Shows which authentication methods are enabled for the user:
|
||||
- Password authentication (has hashed_password)
|
||||
- OIDC authentication (has oidc_id)
|
||||
|
||||
## Navigation
|
||||
- Back to user list
|
||||
- Edit user (with return_to parameter for back navigation)
|
||||
"""
|
||||
use MvWeb, :live_view
|
||||
|
||||
@impl true
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue