View Issue Details

Related ChangesetsJump to NotesJump to History
This issue affects 1 person(s).
 4
IDProjectCategoryView StatusDate SubmittedLast Update
17248Bug reportsDocumentationpublic2021-04-15 12:122026-10-14 16:54
ReporterDenisChenu Assigned Toc_schmitz  
PrioritynoneSeveritytweak 
Status closedResolutionfixed 
Summary17248: No manual or documentation for API functions
Description

No manual for https://github.com/LimeSurvey/LimeSurvey/blob/master/application/libraries/PluginManager/LimesurveyApi.php

Since we use better version system since 3.X : maybe need to create and improve documentation for plugin dev.

Steps To Reproduce

https://manual.limesurvey.org/index.php?search=getTableName

Additional Information

Start to create https://manual.limesurvey.org/Category:API_functions

with a link to https://api.limesurvey.org/classes/LimeSurvey.PluginManager.LimesurveyApi.html

But need manual page to have "this start in version XXX", "Upodated in version XX" etc …

I can create the page

TagsNo tags attached.
Bug heat4
Complete LimeSurvey version number (& build)3.25.20
I will donate to the project if issue is resolvedNo
Browsernot relevant
Database type & versionnot relevant
Server OS (if known)not relevant
Webserver software & version (if known)not relevant
PHP Versionnot relevant
Git branch / Pull Request URLN/A

Users monitoring this issue

There are no users monitoring this issue.

Activities

DenisChenu

DenisChenu

2021-04-15 12:12

developer   ~63948

It's for your OK to create page (or advice)
c_schmitz

c_schmitz

2026-10-14 16:52

administrator   ~86447

Fix committed to master branch: http://bugs.limesurvey.org/plugin.php?page=Source/view&id=40847
c_schmitz

c_schmitz

2026-10-14 16:54

administrator   ~86448

The functions are now documented on the API site, which is built from the current code and stays up to date by itself:
https://api.limesurvey.org/classes/LimeSurvey-PluginManager-LimesurveyApi.html

The link on "Plugins - advanced" still pointed to an old address and needed updating.

Related Changesets

LimeSurvey: master 9f02b358

2026-10-14 16:52

c_schmitz


Details Diff		 Fixed issue 17248: Two plugin API functions had no description in the API documentation
Dev Added missing PHPDoc to LimesurveyApi::createUrl() and LimesurveyApi::removeResponse()		 Affected Issues
17248
mod - application/libraries/PluginManager/LimesurveyApi.php Diff File

Issue History

Date Modified Username Field Change
2021-04-15 12:12 DenisChenu New Issue
2021-04-15 12:12 DenisChenu Status new => assigned
2021-04-15 12:12 DenisChenu Assigned To => ollehar
2021-04-15 12:12 DenisChenu Note Added: 63948
2021-04-15 12:12 DenisChenu Summary No manaul for API functions => No manual or documentation for API functions
2026-10-14 16:52 c_schmitz Changeset attached => LimeSurvey master 9f02b358
2026-10-14 16:52 c_schmitz Note Added: 86447
2026-10-14 16:52 c_schmitz Assigned To ollehar => c_schmitz
2026-10-14 16:52 c_schmitz Status assigned => resolved
2026-10-14 16:52 c_schmitz Resolution open => fixed
2026-10-14 16:52 c_schmitz Bug heat 2 => 4
2026-10-14 16:54 c_schmitz Status resolved => closed
2026-10-14 16:54 c_schmitz Note Added: 86448