www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.learn - Package-level DDoc?

reply Robert Fraser <fraserofthenight gmail.com> writes:
As I write some package-level Javadoc, a thought just came to my mind: is there
any way to create a package summary using DDoc (DMD or Candydoc)?

Also, what's up with the "package" keyword? Does it just not work or is it
doing some scary behavior modification stuff?
Jul 26 2007
next sibling parent Daniel Keep <daniel.keep.lists gmail.com> writes:
Robert Fraser wrote:

 As I write some package-level Javadoc, a thought just came to my mind: is
there any way to create a package summary using DDoc (DMD or Candydoc)?


Not AFAIK.


 Also, what's up with the "package" keyword? Does it just not work or is it
doing some scary behavior modification stuff?


"package" is a protection attribute like "private", "public" and
"protected".  It makes something accessible to other modules in the same
package, but not outside of that.

If you have something declared "package" in the module, say, a.b, then
it's accessible from a.a and a.c, but not from d, e.f or a.g.h

	-- Daniel
Jul 26 2007
prev sibling parent "Jarrett Billingsley" <kb3ctd2 yahoo.com> writes:
"Robert Fraser" <fraserofthenight gmail.com> wrote in message 
news:f8b5p0$1pfc$1 digitalmars.com...


 Also, what's up with the "package" keyword? Does it just not work or is it 
 doing some scary behavior modification stuff?


Despite Daniel's explanation, your intuition is correct about package not 
working correctly.  There are some bugs (143, 257) which have been sitting 
in the bugzilla for over a year with no resolution regarding the 
functionality of the package attribute.  Furthermore, package makes any 
member functions it's applied to non-virtual -- which isn't documented and 
makes no sense.  The interaction of package with other attributes is also 
undefined.  *sigh* if only things like this got more attention than 
constness.
Jul 26 2007