Download Reference Manual
The Developer's Library for D
About Wiki Forums Source Search Contact

Ticket #964 (assigned task)

Opened 6 months ago

Last modified 1 month ago

API documentation of object.di

Reported by: keinfarbton Assigned to: sean (accepted)
Priority: major Milestone: Documentation
Component: Documentation Version: 0.99.5 Jascha
Keywords: Cc: schveiguy

Description

The API documentation is missing objects.di.

Change History

03/23/08 07:25:23 changed by larsivi

  • milestone changed from 0.99.6 to Documentation.

04/08/08 12:50:21 changed by larsivi

  • owner changed from larsivi to sean.

04/23/08 12:46:14 changed by schveiguy

I may know why this doesn't work. I started a new project on dsource, and wanted auto-document generation like tango has. Brad sent me the database table that tango uses to figure out which files should go where, and which should be processed.

The row that says to parse object is:

 id | detail_type |              src               |  dest   
----+-------------+--------------------------------+-----------
  1 | code        | object.di                      | object.di

But this file has no documentation in it. The documentation resides in lib/compiler/*/genobj.d

Two ways to fix this:

  1. copy the documentation to object.di
  2. change the database entry to point to the genobj.d file.

07/25/08 14:51:09 changed by sean

  • status changed from new to assigned.

Will the doc generator parse .di files? I suppose it's worth a try.

07/28/08 13:16:17 changed by schveiguy

  • cc set to schveiguy.

I'm not sure if it works or not, but I don't see why the auto-generator couldn't be made to parse it, even if it doesn't today. A question came up in IRC about how to get file and line number from an exception. Probably wouldn't even be an issue if the docs contained info about Exception...