Developer documentation

Discussions and requests related to new CMSimple features, plugins, templates etc. and how to develop.
Please don't ask for support at this forums!
cmb
Posts: 11675
Joined: Tue Jun 21, 2011 11:04 am
Location: Mü-Sa, RLP, DE
Contact:

Developer documentation

Postby cmb » Thu Jun 01, 2017 2:54 pm

cmb wrote:It seems to me that it makes sense to upgrade to phpDocumentor 2 when we drop PHP 4 support and use PHP 5 features, because the documentation would hugely benefit of the improved support for member visibility and the documentation of exceptions (@throws). The missing support for @global is a problem, but maybe somebody will tackle it in the meantime (even a partial implementation might suffice for our purposes), and IMO we should get rid of the many global variables ASAP, anyway[1].

Time flies (I've posted this 2½ years ago), and I think it's time for a change. phpDocumentor 2 still doesn't support the declaration of global variables and I have lost faith that it ever will. Therefore I propose to switch to Doxygen which is probably the most feature complete general documentation generator, even though PHP isn't 100% supported (for instance, the namespace separator has to be :: instead of PHP's \ in doc block comments for automatic linking). I have opened a "doxygen" branch which is supposed to serve as POC only, and have uploaded the generated documenation.

Thoughts?
Christoph M. Becker –Plugins for CMSimple_XH, but not for CMSimple 4+

utaka
Posts: 51
Joined: Fri Sep 18, 2015 6:00 am
Location: japanese
Contact:

$sl does not appear.Doxygen bug?

Postby utaka » Fri Sep 22, 2017 8:45 am

I am creating a Japanese version of the developer document.

Value $sl does not appear. Why ?
http://www.cmsimple-xh.org/dev-doc/php/ ... _vars.html

I also ran Doxygen, but it was the same, "$sl does not appear".
I confirmed the source code of cms.php , but I did not find a mistake.
https://github.com/cmsimple-xh/cmsimple ... s.php#L322

Doxygen bug?
Does anyone understand the cause?
******************************************************
Japan Site http://cmsimple-jp.org
Twitter Googe+ github
*I English is not a good . I'm sorry...
*Ich habe nicht eine gut Deutsch. Es tut mir leid ...
*Jeg kender ikke dansk
--Powered by Google Translate-----

cmb
Posts: 11675
Joined: Tue Jun 21, 2011 11:04 am
Location: Mü-Sa, RLP, DE
Contact:

Re: $sl does not appear.Doxygen bug?

Postby cmb » Fri Sep 22, 2017 11:03 am

utaka wrote:I am creating a Japanese version of the developer document.

Wow, great! :)

utaka wrote:Value $sl does not appear. Why ?
http://www.cmsimple-xh.org/dev-doc/php/ ... _vars.html

Good catch. Thanks!

That's probably because Doxygen does not see the global declaration (which is "hidden" in an if statement). I suggest to try to add the following before this line:

Code: Select all

$sl = null
Christoph M. Becker –Plugins for CMSimple_XH, but not for CMSimple 4+

utaka
Posts: 51
Joined: Fri Sep 18, 2015 6:00 am
Location: japanese
Contact:

Re: Developer documentation

Postby utaka » Sat Sep 23, 2017 10:54 pm

Thank you ,Christoph!
$sl was displayed. :D

http://cmsimple-jp.org/dev-doc/php/globals_vars.html
******************************************************
Japan Site http://cmsimple-jp.org
Twitter Googe+ github
*I English is not a good . I'm sorry...
*Ich habe nicht eine gut Deutsch. Es tut mir leid ...
*Jeg kender ikke dansk
--Powered by Google Translate-----

cmb
Posts: 11675
Joined: Tue Jun 21, 2011 11:04 am
Location: Mü-Sa, RLP, DE
Contact:

Re: Developer documentation

Postby cmb » Mon Sep 25, 2017 11:08 am

Hm, there are still issues, for instance, http://cmsimple-jp.org/dev-doc/php/cms_ ... 4d430ef688 (which makes no sense). Setting MAX_INITIALIZER_LINES = 0 in Doxyfile helps, but it still not sufficient. It seems as if Doxygen accumulates former code sometimes which is unrelated to a variable/constant. I don't know how to stop that.
Christoph M. Becker –Plugins for CMSimple_XH, but not for CMSimple 4+

utaka
Posts: 51
Joined: Fri Sep 18, 2015 6:00 am
Location: japanese
Contact:

Re: Developer documentation

Postby utaka » Mon Oct 02, 2017 10:32 pm

cmb wrote:Hm, there are still issues, for instance, http://cmsimple-jp.org/dev-doc/php/cms_ ... 4d430ef688 (which makes no sense).


(¯ □ ¯;)! Ha · · ·
But I do not mind (^ o ^; Thank you ,Christoph!

And・・Writing on this topic may be NotBetterS、Sorry,
Please add Two plugins to CMSimple_XH–Wiki(Dokuwiki). Displaying "recent updates" will make it easier to use.

1:plugin:pagelist https://www.dokuwiki.org/start?id=plugin:pagelist
2:plugin:changes https://www.dokuwiki.org/start?id=plugin:changes
It will not hit in "changes", In search of "Dokuwiki's Extension Manager > Search and Install",
Please search with ex. Author name = "Andreas Gohr"

and Add navigationsidebar http://www.cmsimple-xh.org/wiki/doku.ph ... ionsidebar
 example.

Code: Select all

==== Recent Updates ====
{{changes>10&render = pagelist(header,nouser)}}


CMSimple_XH–Wiki is is hard to understand the namespace and page composition.
 Move plugin is also useful if necessary.
******************************************************
Japan Site http://cmsimple-jp.org
Twitter Googe+ github
*I English is not a good . I'm sorry...
*Ich habe nicht eine gut Deutsch. Es tut mir leid ...
*Jeg kender ikke dansk
--Powered by Google Translate-----

cmb
Posts: 11675
Joined: Tue Jun 21, 2011 11:04 am
Location: Mü-Sa, RLP, DE
Contact:

Re: Developer documentation

Postby cmb » Tue Oct 03, 2017 4:53 pm

utaka wrote:Displaying "recent updates" will make it easier to use.

Good idea, thanks! Also for the good description on how to do so.

utaka wrote:CMSimple_XH–Wiki is is hard to understand the namespace and page composition.

Yes, the Wiki is in bad shape. The search function may help a bit, though.
Christoph M. Becker –Plugins for CMSimple_XH, but not for CMSimple 4+

cmb
Posts: 11675
Joined: Tue Jun 21, 2011 11:04 am
Location: Mü-Sa, RLP, DE
Contact:

Re: Developer documentation

Postby cmb » Fri Oct 06, 2017 3:54 pm

cmb wrote:Hm, there are still issues, for instance, http://cmsimple-jp.org/dev-doc/php/cms_ ... 4d430ef688 (which makes no sense). Setting MAX_INITIALIZER_LINES = 0 in Doxyfile helps, but it still not sufficient. It seems as if Doxygen accumulates former code sometimes which is unrelated to a variable/constant. I don't know how to stop that.

For the record: I have been able to improve this (and some other stuff) – it's still far from being perfect, though: http://dev-doc.cmsimple-xh.org/
Christoph M. Becker –Plugins for CMSimple_XH, but not for CMSimple 4+


Return to “Open Development”

Who is online

Users browsing this forum: No registered users and 2 guests