Opened 3 years ago
Closed 2 years ago
#2450 closed Documentation (Closed)
Update all inline documentation
| Reported by: | brettp | Owned by: | brettp |
|---|---|---|---|
| Priority: | normal | Milestone: | |
| Component: | Core | Version: | Github Master |
| Severity: | minor | Keywords: | |
| Cc: | brettp | Difficulty: | moderate |
Description
- Make sure all documentation is clear and accurate.
- Add examples via external example files.
Change History (26)
comment:1 Changed 3 years ago by brettp
comment:2 Changed 3 years ago by brettp
(In [svn:6911]) Refs #2450: Documentation for account/ files added.
comment:3 Changed 3 years ago by ewinslow
(In [svn:6915]) Refs #2450: Fixed some typos in css/js simplecache documentation
comment:4 Changed 3 years ago by brettp
(In [svn:6917]) Refs #2450: Documented db-related $CONFIG vars.
comment:5 Changed 3 years ago by brettp
(In [svn:6918]) Refs #2450: Added db_disable_query_cache to settings.example.php.
comment:6 Changed 3 years ago by brettp
(In [svn:6919]) Refs #2450: Documentation added for database functions.
comment:7 Changed 3 years ago by brettp
(In [svn:6921]) Refs #2450: Documented configuration.php.
comment:8 Changed 3 years ago by brettp
(In [svn:6929]) Refs #2450: Updated docs for core admin actions.
comment:9 Changed 3 years ago by brettp
(In [svn:6930]) Refs #2450: Removing @see and @uses. Replaced NB: with English phrases.
comment:10 Changed 3 years ago by brettp
(In [svn:6931]) Refs #2450: Really removed the @uses and @see tags.
comment:11 Changed 3 years ago by brettp
(In [svn:6932]) Refs #2450: Added documentation to elgglib.
comment:12 Changed 3 years ago by brettp
(In [svn:6937]) Refs #2450: Added config.php stub to document many of the $CONFIG vars.
comment:13 Changed 3 years ago by brettp
(In [svn:6939]) Refs #2450: Documented engine/start.php
comment:14 Changed 3 years ago by brettp
(In [svn:6940]) Refs #2450: Updated docs for account/*
comment:15 Changed 3 years ago by brettp
(In [svn:6942]) Refs #2450: Documented handler files.
comment:16 Changed 3 years ago by brettp
(In [svn:6949]) Refs #2450: Added documentation for actions.
comment:17 Changed 3 years ago by brettp
(In [svn:6951]) Refs #2450: Documented views.php.
comment:18 Changed 3 years ago by brettp
(In [svn:6952]) Refs #2450: Documented first bit of the classes.
comment:19 Changed 3 years ago by brettp
(In [svn:6953]) Refs #2450: Changed the subpackage and fixed a typo.
comment:20 Changed 3 years ago by brettp
(In [svn:6954]) Refs #2450: ElggEntity documented.
comment:21 Changed 3 years ago by brettp
(In [svn:6955]) Refs #2450: Documented ElggObject.
comment:22 Changed 3 years ago by brettp
(In [svn:6956]) Refs #2450: Documented a few more classes.
comment:23 Changed 3 years ago by brettp
(In [svn:6958]) Refs #2450: Documented ElggSite, clarified some docs on ElggObject.
comment:24 Changed 3 years ago by brettp
- Difficulty set to moderate
- Milestone Elgg 1.8 deleted
This ticket is never go to be closed. I'm moving the milestone off 1.8. Also thinking about adding a "Enjoyable" field to Trac.
comment:25 Changed 2 years ago by ewinslow
Is it even useful to have this open?
comment:26 Changed 2 years ago by brettp
- Resolution set to Closed
- Status changed from new to closed
As enjoyable as an albatross around our necks.
(In [svn:6910]) Refs #2450: Added the default viewtype in the views dir for the @see tag.