Item1135: Missing API documentation

Priority: Urgent
Current State: Closed
Released In: 1.0.2
Target Release: patch
Applies To: Engine
Component: Documentation
Branches:
Reported By: WillNorris
Waiting For: WillNorris
Last Change By: KennethLavrsen
FoswikiFuncDotPm , FoswikiMetaDotPm , and FoswikiSandboxDotPm

(foswiki.org doesn't have those topics in System, because it is an svn-based installation).

these files aren't included in the 1.0.0 tgz/zip

(see also TWiki:TWiki04x02.TWikiFuncDotPm TWiki:TWiki04x02.TWikiMetaDotPm TWiki:TWiki04x02.TWikiSandboxDotPm

-- WillNorris - 24 Feb 2009

Those files no longer exist and are no longer required. POD documentation is generated on the fly from the release sources.

Use instead.

-- CrawfordCurrie - 24 Feb 2009

ok, cool. i even vaguely remember a discussion about that...

so, i will change all instances Foswiki*DotPm to PerlDoc references

-- WillNorris - 24 Feb 2009

list to consider:
wbniv@r17311:~/foswiki.org/trunk$ grep -R DotPm . | grep -v '.svn' | grep -v '~'
./X509UserPlugin/lib/Foswiki/Users/X509PasswdUser.pm:Subclass of [[FoswikiUsersPasswordDotPm][ =Foswiki::Users::Password= ]].
./HTTPDUserAdminContrib/lib/TWiki/Users/HTTPDUserAdminUser.pm:Subclass of [[WikiUsersPasswordDotPm][ =TWiki::Users::Password= ]].
./HTTPDUserAdminContrib/lib/TWiki/Users/HTTPDUserAdminUser.pm:[[WikiUsersHtPasswdUserDotPm][ =TWiki::Users::HtPasswdUser=]];
./SpanishTWikiContrib/data/TWiki_ES/GlosarioTWiki.txt:| Plugin API: | El interfaz est�ndar para crear TWiki _Plugins_ y programas adicionales que asegura una integraci�n perfecta. [[%SYSTEMWEB%.TWikiFuncDotPm][Detalles...]] %FLAGGB% |
./core/tools/gendocs.pl:                    $p .= "DotPm";
./core/lib/Foswiki/Users/HtPasswdUser.pm:Subclass of [[WikiUsersPasswordDotPm][ =Foswiki::Users::Password= ]].
./core/lib/Foswiki/Users/ApacheHtpasswdUser.pm:Subclass of [[WikiUsersPasswordDotPm][ =Foswiki::Users::Password= ]].
./core/lib/Foswiki/Users/ApacheHtpasswdUser.pm:[[WikiUsersHtPasswdUserDotPm][ =Foswiki::Users::HtPasswdUser=]];
./core/data/System/CompleteDocumentation.txt:%INCLUDE{"FoswikiFuncDotPm"}%
./core/data/System/DevelopingPlugins.txt:Plugins sometimes need to store data. This can be plugin internal data such as cache data, or data generated for browser consumption such as images. Plugins should store data using FoswikiFuncDotPm functions that support saving and loading of topics and attachments.
./core/data/System/DevelopingPlugins.txt:The plugin interface (FoswikiFuncDotPm functions and plugin handlers) evolve over time. Foswiki introduces new API functions to address the needs of plugin authors. Plugins using unofficial Foswiki internal functions may no longer work on a Foswiki upgrade.
./core/data/System/DevelopingPlugins.txt:From time-to-time, the Foswiki developers will add new functions to the interface (either to FoswikiFuncDotPm, or new handlers). Sometimes these improvements mean that old functions have to be deprecated to keep the code manageable. When this happens, the deprecated functions will be supported in the interface for at least one more Foswiki release, and probably longer, though this cannot be guaranteed.
./CpanContrib/tools/install-cpan.pl:    createMyConfigDotPm({ cpan => $cpan, config => $optsConfig->{config} });
./CpanContrib/tools/install-cpan.pl:sub createMyConfigDotPm

-- WillNorris - 24 Feb 2009

ItemTemplate edit

Summary Missing API documentation
ReportedBy WillNorris
Codebase
SVN Range Foswiki-1.0.0, Thu, 08 Jan 2009, build 1878
AppliesTo Engine
Component Documentation
Priority Urgent
CurrentState Closed
WaitingFor WillNorris
Checkins distro:dd7f5ea1d5af HTTPDUserAdminContrib:71c661c34ae3 X509UserPlugin:0086b2688632
TargetRelease patch
ReleasedIn 1.0.2
Topic revision: r11 - 25 Feb 2009, KennethLavrsen
 
The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. see CopyrightStatement. Creative Commons License