Forums / Developer / what about api reference?

what about api reference?

Author Message

Rami Grossman

Wednesday 30 June 2004 2:48:35 am

When I try to learn how to work with API its like walking in the dark and sticking into walls.

Will there be any API reference like there was with the previous version of eZ publish?
I saw something in the pubsvn section for 3.1 : http://pubsvn.ez.no/sdk/ref/view/functions

Thanks
Rami

Paul Forsyth

Wednesday 30 June 2004 3:44:48 am

You can do this right now. Use doxygen:

http://ez.no/ez_publish/documentation/development/using_doxygen_to_create_api_documentation

paul

--
http://www.visionwt.com

Alex Jones

Wednesday 30 June 2004 6:19:24 am

Perhaps someone who has already installed Doxygen and created the API documentation could post it as a contribution..? That would save a lot of time and trouble for quite a few others. :)

Alex

Alex
[ bald_technologist on the IRC channel (irc.freenode.net): #eZpublish ]

<i>When in doubt, clear the cache.</i>

Paul Forsyth

Wednesday 30 June 2004 6:31:52 am

This is already available:

http://pubsvn.ez.no/doxygen/

Click on the top links, eg: http://pubsvn.ez.no/doxygen/modules.html

paul

--
http://www.visionwt.com

Alex Jones

Wednesday 30 June 2004 7:08:18 am

Beautiful! Thanks for posting it Paul.

Alex

Alex
[ bald_technologist on the IRC channel (irc.freenode.net): #eZpublish ]

<i>When in doubt, clear the cache.</i>

eZ debug

Timing: Jan 19 2025 11:40:22
Script start
Timing: Jan 19 2025 11:40:22
Module start 'content'
Timing: Jan 19 2025 11:40:23
Module end 'content'
Timing: Jan 19 2025 11:40:23
Script end

Main resources:

Total runtime1.0125 sec
Peak memory usage4,096.0000 KB
Database Queries202

Timing points:

CheckpointStart (sec)Duration (sec)Memory at start (KB)Memory used (KB)
Script start 0.00000.0093 590.0859180.8359
Module start 'content' 0.00930.8551 770.9219592.9922
Module end 'content' 0.86440.1480 1,363.9141337.3750
Script end 1.0124  1,701.2891 

Time accumulators:

 Accumulator Duration (sec) Duration (%) Count Average (sec)
Ini load
Load cache0.00410.4088210.0002
Check MTime0.00160.1587210.0001
Mysql Total
Database connection0.00140.141210.0014
Mysqli_queries0.936392.47922020.0046
Looping result0.00230.22622000.0000
Template Total0.980896.920.4904
Template load0.00240.232820.0012
Template processing0.978496.631520.4892
Template load and register function0.00020.020110.0002
states
state_id_array0.00090.089010.0009
state_identifier_array0.00080.074220.0004
Override
Cache load0.00190.1870290.0001
Sytem overhead
Fetch class attribute can translate value0.00160.159140.0004
Fetch class attribute name0.00140.138660.0002
XML
Image XML parsing0.00110.108540.0003
class_abstraction
Instantiating content class attribute0.00000.001870.0000
General
dbfile0.00180.1822270.0001
String conversion0.00000.000930.0000
Note: percentages do not add up to 100% because some accumulators overlap

CSS/JS files loaded with "ezjscPacker" during request:

CacheTypePacklevelSourceFiles
CSS0extension/community/design/community/stylesheets/ext/jquery.autocomplete.css
extension/community_design/design/suncana/stylesheets/scrollbars.css
extension/community_design/design/suncana/stylesheets/tabs.css
extension/community_design/design/suncana/stylesheets/roadmap.css
extension/community_design/design/suncana/stylesheets/content.css
extension/community_design/design/suncana/stylesheets/star-rating.css
extension/community_design/design/suncana/stylesheets/syntax_and_custom_tags.css
extension/community_design/design/suncana/stylesheets/buttons.css
extension/community_design/design/suncana/stylesheets/tweetbox.css
extension/community_design/design/suncana/stylesheets/jquery.fancybox-1.3.4.css
extension/bcsmoothgallery/design/standard/stylesheets/magnific-popup.css
extension/sevenx/design/simple/stylesheets/star_rating.css
extension/sevenx/design/simple/stylesheets/libs/fontawesome/css/all.min.css
extension/sevenx/design/simple/stylesheets/main.v02.css
extension/sevenx/design/simple/stylesheets/main.v02.res.css
JS0extension/ezjscore/design/standard/lib/yui/3.17.2/build/yui/yui-min.js
extension/ezjscore/design/standard/javascript/jquery-3.7.0.min.js
extension/community_design/design/suncana/javascript/jquery.ui.core.min.js
extension/community_design/design/suncana/javascript/jquery.ui.widget.min.js
extension/community_design/design/suncana/javascript/jquery.easing.1.3.js
extension/community_design/design/suncana/javascript/jquery.ui.tabs.js
extension/community_design/design/suncana/javascript/jquery.hoverIntent.min.js
extension/community_design/design/suncana/javascript/jquery.popmenu.js
extension/community_design/design/suncana/javascript/jScrollPane.js
extension/community_design/design/suncana/javascript/jquery.mousewheel.js
extension/community_design/design/suncana/javascript/jquery.cycle.all.js
extension/sevenx/design/simple/javascript/jquery.scrollTo.js
extension/community_design/design/suncana/javascript/jquery.cookie.js
extension/community_design/design/suncana/javascript/ezstarrating_jquery.js
extension/community_design/design/suncana/javascript/jquery.initboxes.js
extension/community_design/design/suncana/javascript/app.js
extension/community_design/design/suncana/javascript/twitterwidget.js
extension/community_design/design/suncana/javascript/community.js
extension/community_design/design/suncana/javascript/roadmap.js
extension/community_design/design/suncana/javascript/ez.js
extension/community_design/design/suncana/javascript/ezshareevents.js
extension/sevenx/design/simple/javascript/main.js

Templates used to render the page:

UsageRequested templateTemplateTemplate loadedEditOverride
1node/view/full.tplfull/forum_topic.tplextension/sevenx/design/simple/override/templates/full/forum_topic.tplEdit templateOverride template
5content/datatype/view/ezxmltext.tpl<No override>extension/community_design/design/suncana/templates/content/datatype/view/ezxmltext.tplEdit templateOverride template
9content/datatype/view/ezxmltags/paragraph.tpl<No override>extension/ezwebin/design/ezwebin/templates/content/datatype/view/ezxmltags/paragraph.tplEdit templateOverride template
4content/datatype/view/ezxmltags/line.tpl<No override>design/standard/templates/content/datatype/view/ezxmltags/line.tplEdit templateOverride template
2content/datatype/view/ezimage.tpl<No override>extension/sevenx/design/simple/templates/content/datatype/view/ezimage.tplEdit templateOverride template
1pagelayout.tpl<No override>extension/sevenx/design/simple/templates/pagelayout.tplEdit templateOverride template
 Number of times templates used: 22
 Number of unique templates used: 6

Time used to render debug report: 0.0002 secs