On Sat, Aug 31, 2013 at 11:56 PM, Isaac Bennetch <bennetch(a)gmail.com> wrote:
On Aug 31, 2013, at 5:09 PM, "J. M." <mynetx(a)users.sf.net> wrote:
From: mohamed.ashraf.213(a)gmail.com
Date: Sat, 31 Aug 2013 23:03:50 +0200
To: phpmyadmin-devel(a)lists.sourceforge.net
Subject: [Phpmyadmin-devel] Documentation standard for error reporting
server
Is there some documentation standard for the error reporting server or
should I create one. Also if we are using a template made for php docs,
special treatment must be given to controller actions since they normally
do not return anything and have a lot of metadata connected to them through
the router in the form of the urls that lead to them.
--
Mohamed Ashraf
I favorite Readthedocs - Can the team member who had set this up,
elaborate, please?
- JM
I believe Michal set this up, but he has limited email access this week.
That's for user documentation; if Mohamed means developer documentation
that can happen in the wiki in the Devel namespace. That's of course in
addition to the in-line function block comments. Mohamed, perhaps you can
elaborate a bit and we can help further — if you need wiki space I
certainly can assist you in finding the right place to put things.
I am talking about the mandatory doc blocks for created functions in the
phpmyadmin codebase. I am asking if there was something of the sort for the
error reporting server codebase or not. I am talking about developer docs
for someone who needs to fix a bug somewhere and needs to understand what a
function does. I normally rely on other developers reading the code and
understanding it. However that was not the direction you seem to be going
with in the phpmyadmin codebase so I was wondering how will we go along
with the error reporting server codebase.
------------------------------------------------------------------------------
Learn the latest--Visual Studio 2012, SharePoint 2013, SQL 2012, more!
Discover the easy way to master current and previous Microsoft technologies
and advance your career. Get an incredible 1,500+ hours of step-by-step
tutorial videos with LearnDevNow. Subscribe today and save!
http://pubads.g.doubleclick.net/gampad/clk?id=58040911&iu=/4140/ostg.cl…
_______________________________________________
Phpmyadmin-devel mailing list
Phpmyadmin-devel(a)lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/phpmyadmin-devel
------------------------------------------------------------------------------
Learn the latest--Visual Studio 2012, SharePoint 2013, SQL 2012, more!
Discover the easy way to master current and previous Microsoft technologies
and advance your career. Get an incredible 1,500+ hours of step-by-step
tutorial videos with LearnDevNow. Subscribe today and save!
http://pubads.g.doubleclick.net/gampad/clk?id=58040911&iu=/4140/ostg.cl…
_______________________________________________
Phpmyadmin-devel mailing list
Phpmyadmin-devel(a)lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/phpmyadmin-devel
--
Mohamed Ashraf