Brad Fitzpatrick (bradfitz) wrote in lj_dev,
Brad Fitzpatrick
bradfitz
lj_dev

LJFUNC

In addition to <LJDEP>, there now exists <LJFUNC> markup in comments to document the LJ API. I started to markup ljlib.pl with the info and I wrote bin/apidoc.pl to scan the libraries and spit out a Data::Dumper tree of what it parsed.

Hopefully we'll be able to get this into our main structured documentation directory one day which we'll be theoretically able to convert to a dozen formats... PDF, TXT, HTML, etc.

In the meantime (because I'm pessimistic about us ever getting real structured documentation and a makefile), I'll write something to spit it out on a webpage. My goal is to at least kick start getting meta-data on everything so one day when we do have a structured documentation system (XML, DocBook, perl data structures, whatever) we'll be able to have some raw data to spit out.
Subscribe
  • Post a new comment

    Error

    Anonymous comments are disabled in this journal

    default userpic

    Your reply will be screened

    Your IP address will be recorded 

  • 0 comments