Item507: ClassMethod, StaticMethod, ObjectMethod are 3 geek docs orphaned and seems not relevant to put in distro

Reported on Item485.

ClassMethod, StaticMethod, ObjectMethod are a group of orphan pages, not relevant to normal documentation?

Answer

Good question. They were added recently by Gilmar. They link to each other but add no value to and end user or sysadmin. They are developer docs. So I leave them on SVN but remove them from distribution.

Action - remove from MANIFEST

-- KennethLavrsen - 17 Dec 2008

These topics are not orphans.

All the POD documentation in-line in code uses ClassMethod, StaticMethod etc to indicate the type of the method. When a POD document is generated (via %INCLUDE{"doc:Foswiki::Meta"}% for example) the rendered document links to these definitions. Visit DevelopingPlugins and click Foswiki::Meta to see the effect of removing them.

They are required for documentation of the APIs, so I recommend you revert this checkin. Re-opened the report and raised to Urgent.

-- CrawfordCurrie - 17 Dec 2008

I see now why both I and the reporter saw them orphaned. They are called from generated content. Not from a static topic. So the backlink feature cannot find the parent.

Reverted and closing

-- KennethLavrsen - 17 Dec 2008