1234064 - makedocs.pl excludes all files under Bugzilla/API/1_0/ when compiling POD

Status: NEW

(Bugzilla :: Documentation, defect)

Description

[Frédéric Buclin]

When looking for files to compile their POD documentation, Pod::Simple::Search::_make_search_callback() automatically excludes all directories which do not match 

  m/^([A-Za-z][a-zA-Z0-9_]*)\z/s

This means that Bugzilla/API/1_0/ is excluded. If we are fine with that, then we shouldn't waste our time to write POD for these files. Else we should find a way to workaround this problem. _make_search_callback() seems too big and ugly to be easily overriden.

Comment 1

[David Lawrence [:dkl]]

(In reply to Frédéric Buclin from comment #0)
> When looking for files to compile their POD documentation,
> Pod::Simple::Search::_make_search_callback() automatically excludes all
> directories which do not match 
> 
>   m/^([A-Za-z][a-zA-Z0-9_]*)\z/s
> 
> This means that Bugzilla/API/1_0/ is excluded. If we are fine with that,
> then we shouldn't waste our time to write POD for these files. Else we
> should find a way to workaround this problem. _make_search_callback() seems
> too big and ugly to be easily overriden.

Personally I am fine with removing all client related POD from those files and relying only on the rST docs. The main reason they are there now is because they were copied from the old locations and was easier to just leave it in.

dkl