Ticket #238 (closed enhancement: fixed)
Need to more of documentation by development
| Reported by: | slavazanko | Owned by: | slavazanko |
|---|---|---|---|
| Priority: | major | Milestone: | 4.7 |
| Component: | mc-core | Version: | 4.6.2 |
| Keywords: | committed-master | Cc: | |
| Blocked By: | Blocking: | ||
| Branch state: | Votes for changeset: |
Description
We need to well documented all functions in project.
As we discussed in jabber-room, we will use doxygen (and will use doxygen-tags in comments).
Change History
comment:1 Changed 15 years ago by slavazanko
- Status changed from new to accepted
- Owner set to slavazanko
- Keywords rework added
comment:2 Changed 15 years ago by slavazanko
- Keywords review added; rework removed
well... Review, vote please.
Some comments:
After running './autogen.sh' go into 'doc' subdir and run
make doxygen-doc
this command will build documentation html-site (into doc/devel subdir).
But created documentation stuff is a very big (more that 380Mb) and IMHO really don't need for add to repro...
Secondary, I don't know where place own *.m4 files. As fact, all files in ./m4 subdir may be autogenerated stuff... file ./acinclude.m4 very big for later simple review...
I was create 'm4.include' subdir and was place dx_doxygen.m4 file into this subdir...
May be, this ticket must be blocked by 'HACK_autoconf' branch...
comment:3 Changed 15 years ago by metux
yep, our own m4 stuff belongs into m4.include (as done in the HACK_autoconf) branch.
BTW: we should move things from HACK_autoconf to master, step by step.
comment:4 follow-up: ↓ 5 Changed 15 years ago by styx
mc/doc$ make doxygen-doc
make: * No rule to make target `doxygen-doc'. Stop.
:(
comment:5 in reply to: ↑ 4 Changed 15 years ago by styx
Replying to styx:
mc/doc$ make doxygen-doc
make: * No rule to make target `doxygen-doc'. Stop.
:(
oh, I know the problem: --enable-maintainer-mode (:
comment:6 Changed 15 years ago by slavazanko
branch '238_doxygen' now rebased to HEAD of 'master' branch.
review, vote, say proposes and wishes here, please
comment:7 Changed 15 years ago by kdave
Please clean up the branch before merging to master. The commit with immediate revert only pollute the logs.
Commit 3cde750956a531aad81259151a8a9d6bc774bb82 'Revert "Some simple discriptions for files in src dir"' reverts 04c001143553b6cbfa7fa0ea80804ec4433f5fd8 which cannot be found in git log, nor 'git describe 04c0011' can find it. However 'git show' does show the correct commit.
Next time please enter the correct commit id (20f8d1a7 in that case) for a revert, or better try to avoid reverts.
HTH
comment:8 Changed 15 years ago by styx
- Keywords vote-styx added
we can just cherry-pick needed patches and all be ok (:
comment:10 Changed 15 years ago by styx
Can some one review this one? It is enough important ticket
comment:12 Changed 15 years ago by slavazanko
- Keywords committed-master added; vote-styx vote-andrew_b approved removed
- Status changed from accepted to testing
- Resolution set to fixed
- Blocking 252 removed
Created branch 238_doxygen; parent branch: master
Need to review and rework