Re: [uportal-dev] javadoc for uportal

2010-10-25 Thread Eric Dalquist 

On Maven sites it is under the Project Reports section.

I just noticed that the nightly site build for person directory is 
disabled. I'll create a jira to fix this.


-Eric

On 10/25/10 4:39 PM, Susan Bramhall wrote:
Hmm.  I see 
http://developer.jasig.org/projects/person-directory/1.5.0-RC6/person-directory-impl/index.html 
but no link for javadocs.  If I try 
http://developer.jasig.org/projects/person-directory/1.5.0-RC6/person-directory-impl/apidocs/index.html 
I get page not found.  I also only see builds up to RC6 while svn is 
up to RC8 so maybe that site is not so perfect?

Susan

On 10/25/2010 4:46 PM, Eric Dalquist wrote:
We have nightly builds and release builds of the maven site for 
uPortal and other projected hosted here: http://developer.jasig.org/
Any project that uses the Jasig maven parent pom has the ability to 
publish a maven site to that domain with a little coordination with 
the infrastructure team, though that last bit is yet to be documented.


Unfortunately the maven generated site is broken and I haven't had 
time to figure out why so while the javadocs are there the links are 
missing :(

For example:
http://developer.jasig.org/projects/uportal/3.2.4/uportal-impl/apidocs/index.html

I believe the maven sites for person directory are working.

-Eric



On 10/25/2010 03:43 PM, Susan Bramhall wrote:
At the Unconference, I volunteered to document the default 
personDirectoryContext.xml.  In the course of documenting 
configuration instructions and examples for the most common Person 
Directory basics, I realized that this powerful API and all the 
existing implementations should to be documented.  Even if I could 
correctly write documentation for all the classes as currently 
implemented, the wiki is bound to fall out of date as soon as any 
change is made to the code base.  My thinking is that the best way 
to ensure that the documentation is current is to link to an html 
published version of the JavaDoc.  I have two questions for the list:


   1. Do you agree that having JavaDoc published somewhere on the
  web is a good idea?  See, for example,
  http://www.sonarsource.org/docs/ where you can browse to the
  javadoc for any version.
   2. Is this something the existing build infrastructure could do -
  at least when a release is tagged?

Susan
--

Susan Bramhall (susan.bramh...@yale.edu 
)

Enterprise Architect
Yale University Information Technology Services (ITS)
25 Science Park, 150 Munson St, New Haven, CT 06520
Phone:  203 432 6697

--

You are currently subscribed touportal-...@lists.ja-sig.org  
as:eric.dalqu...@doit.wisc.edu
To unsubscribe, change settings or access archives, 
seehttp://www.ja-sig.org/wiki/display/JSG/uportal-dev


--

Susan Bramhall (susan.bramh...@yale.edu )
Enterprise Architect
Yale University Information Technology Services (ITS)
25 Science Park, 150 Munson St, New Haven, CT 06520
Phone:  203 432 6697

--

You are currently subscribed to uportal-dev@lists.ja-sig.org as: 
eric.dalqu...@doit.wisc.edu
To unsubscribe, change settings or access archives, see 
http://www.ja-sig.org/wiki/display/JSG/uportal-dev


smime.p7s
Description: S/MIME Cryptographic Signature

Re: [uportal-dev] javadoc for uportal

2010-10-25 Thread Susan Bramhall 


  
  
Hmm.  I see http://developer.jasig.org/projects/person-directory/1.5.0-RC6/person-directory-impl/index.html
but no link for javadocs.  If I try http://developer.jasig.org/projects/person-directory/1.5.0-RC6/person-directory-impl/apidocs/index.html
I get page not found.  I also only see builds up to RC6 while svn is
up to RC8 so maybe that site is not so perfect?
Susan

On 10/25/2010 4:46 PM, Eric Dalquist wrote:

  
  We have nightly builds and release builds of the maven site for
  uPortal
  and other projected hosted here: http://developer.jasig.org/
  Any project that uses the Jasig maven parent pom has the ability
  to
  publish a maven site to that domain with a little coordination
  with the
  infrastructure team, though that last bit is yet to be documented.
  
  Unfortunately the maven generated site is broken and I haven't had
  time
  to figure out why so while the javadocs are there the links are
  missing
  :(
  For example:
  http://developer.jasig.org/projects/uportal/3.2.4/uportal-impl/apidocs/index.html
  
  I believe the maven sites for person directory are working.
  
  -Eric
  
  
  
  On 10/25/2010 03:43 PM, Susan Bramhall wrote:
  

At the Unconference, I volunteered to document the default
personDirectoryContext.xml.  In the course of documenting
configuration
instructions and examples for the most common Person Directory
basics,
I realized that this powerful API and all the existing
implementations
should to be documented.  Even if I could correctly write
documentation
for all the classes as currently implemented, the wiki is bound
to fall
out of date as soon as any change is made to the code base.  My
thinking is that the best way to ensure that the documentation
is
current is to link to an html published version of the JavaDoc. 
I have
two questions for the list:

  Do you agree that having JavaDoc published somewhere on
the web
is a good idea?  See, for example, http://www.sonarsource.org/docs/
where you can browse to the javadoc for any version.
  Is this something the existing build infrastructure could
do -
at least when a release is tagged?

Susan
-- 
  
  
  
  
Susan
Bramhall
  (susan.bramh...@yale.edu)
  Enterprise Architect 
  Yale University Information Technology Services (ITS)
  25 Science Park, 150 Munson St, New Haven, CT 06520
  Phone:  203 432 6697
  

-- 

You are currently subscribed to uportal-dev@lists.ja-sig.org as: eric.dalqu...@doit.wisc.edu
To unsubscribe, change settings or access archives, see http://www.ja-sig.org/wiki/display/JSG/uportal-dev
  


-- 
  
  
  
  
Susan Bramhall
  (susan.bramh...@yale.edu)
  Enterprise Architect 
  Yale University Information Technology Services (ITS)
  25 Science Park, 150 Munson St, New Haven, CT 06520
  Phone:  203 432 6697
  

  
-- 
You are currently subscribed to uportal-dev@lists.ja-sig.org as: arch...@mail-archive.comTo unsubscribe, change settings or access archives, see http://www.ja-sig.org/wiki/display/JSG/uportal-dev

Re: [uportal-dev] javadoc for uportal

2010-10-25 Thread Benito J. Gonzalez 

Great idea!  It will encourage us to keep our comments up to date.

Benito J. Gonzalez
Manager, Enterprise Web Application Development
Information Technology Department
University of California, Merced
Desk: 209.228.2974
Cell: 209.201.5052
Email: bgonzal...@ucmerced.edu


On 10/25/10 13:43, Susan Bramhall wrote:
At the Unconference, I volunteered to document the default 
personDirectoryContext.xml.  In the course of documenting 
configuration instructions and examples for the most common Person 
Directory basics, I realized that this powerful API and all the 
existing implementations should to be documented.  Even if I could 
correctly write documentation for all the classes as currently 
implemented, the wiki is bound to fall out of date as soon as any 
change is made to the code base.  My thinking is that the best way to 
ensure that the documentation is current is to link to an html 
published version of the JavaDoc.  I have two questions for the list:


   1. Do you agree that having JavaDoc published somewhere on the web
  is a good idea?  See, for example,
  http://www.sonarsource.org/docs/ where you can browse to the
  javadoc for any version.
   2. Is this something the existing build infrastructure could do -
  at least when a release is tagged?

Susan
--

Susan Bramhall (susan.bramh...@yale.edu )
Enterprise Architect
Yale University Information Technology Services (ITS)
25 Science Park, 150 Munson St, New Haven, CT 06520
Phone:  203 432 6697

--

You are currently subscribed to uportal-dev@lists.ja-sig.org as: 
bgonzal...@ucmerced.edu
To unsubscribe, change settings or access archives, see 
http://www.ja-sig.org/wiki/display/JSG/uportal-dev


--
You are currently subscribed to uportal-dev@lists.ja-sig.org as: 
arch...@mail-archive.com
To unsubscribe, change settings or access archives, see 
http://www.ja-sig.org/wiki/display/JSG/uportal-dev

Re: [uportal-dev] javadoc for uportal

2010-10-25 Thread Eric Dalquist 
We have nightly builds and release builds of the maven site for uPortal 
and other projected hosted here: http://developer.jasig.org/
Any project that uses the Jasig maven parent pom has the ability to 
publish a maven site to that domain with a little coordination with the 
infrastructure team, though that last bit is yet to be documented.


Unfortunately the maven generated site is broken and I haven't had time 
to figure out why so while the javadocs are there the links are missing :(

For example:
http://developer.jasig.org/projects/uportal/3.2.4/uportal-impl/apidocs/index.html

I believe the maven sites for person directory are working.

-Eric



On 10/25/2010 03:43 PM, Susan Bramhall wrote:
At the Unconference, I volunteered to document the default 
personDirectoryContext.xml.  In the course of documenting 
configuration instructions and examples for the most common Person 
Directory basics, I realized that this powerful API and all the 
existing implementations should to be documented.  Even if I could 
correctly write documentation for all the classes as currently 
implemented, the wiki is bound to fall out of date as soon as any 
change is made to the code base.  My thinking is that the best way to 
ensure that the documentation is current is to link to an html 
published version of the JavaDoc.  I have two questions for the list:


   1. Do you agree that having JavaDoc published somewhere on the web
  is a good idea?  See, for example,
  http://www.sonarsource.org/docs/ where you can browse to the
  javadoc for any version.
   2. Is this something the existing build infrastructure could do -
  at least when a release is tagged?

Susan
--

Susan Bramhall (susan.bramh...@yale.edu )
Enterprise Architect
Yale University Information Technology Services (ITS)
25 Science Park, 150 Munson St, New Haven, CT 06520
Phone:  203 432 6697

--

You are currently subscribed to uportal-dev@lists.ja-sig.org as: 
eric.dalqu...@doit.wisc.edu
To unsubscribe, change settings or access archives, see 
http://www.ja-sig.org/wiki/display/JSG/uportal-dev


smime.p7s
Description: S/MIME Cryptographic Signature

Re: [uportal-dev] javadoc for uportal

2010-10-25 Thread Susan Bramhall 


  
  
Twenty classes implementing IPersonAttributeDAO: 

  AbstractAggregatingDefaultQueryPersonAttributeDao,
AbstractDefaultAttributePersonAttributeDao,
AbstractFlatteningPersonAttributeDao,
AbstractJdbcPersonAttributeDao,
AbstractQueryPersonAttributeDao,
AdditionalDescriptorsPersonAttributeDao,
BasePersonAttributeDao,
CachingPersonAttributeDaoImpl,
CascadingPersonAttributeDao,
ComplexStubPersonAttributeDao,
DeclaredRulePersonAttributeDao,
EchoPersonAttributeDaoImpl,
LdapPersonAttributeDao,
MergingPersonAttributeDaoImpl,
MessageFormatPersonAttributeDao,
MultiRowJdbcPersonAttributeDao,
RegexGatewayPersonAttributeDao,
SingleRowJdbcPersonAttributeDao,
StubPersonAttributeDao,
XmlPersonAttributeDao


On 10/25/2010 4:43 PM, Susan Bramhall wrote:

  
  At the Unconference, I volunteered to document the default
  personDirectoryContext.xml.  In the course of documenting
  configuration instructions and examples for the most common Person
  Directory basics, I realized that this powerful API and all the
  existing implementations should to be documented.  Even if I could
  correctly write documentation for all the classes as currently
  implemented, the wiki is bound to fall out of date as soon as any
  change is made to the code base.  My thinking is that the best way
  to ensure that the documentation is current is to link to an html
  published version of the JavaDoc.  I have two questions for the
  list:
  
Do you agree that having JavaDoc published somewhere on the
  web is a good idea?  See, for example, http://www.sonarsource.org/docs/
  where you can browse to the javadoc for any version.
Is this something the existing build infrastructure could do
  - at least when a release is tagged?
  
  Susan
  -- 




  Susan Bramhall
(susan.bramh...@yale.edu)
Enterprise Architect 
Yale University Information Technology Services (ITS)
25 Science Park, 150 Munson St, New Haven, CT 06520
Phone:  203 432 6697

  
  -- 

You are currently subscribed to uportal-dev@lists.ja-sig.org as: susan.bramh...@yale.edu
To unsubscribe, change settings or access archives, see http://www.ja-sig.org/wiki/display/JSG/uportal-dev


-- 
  
  
  
  
Susan Bramhall
  (susan.bramh...@yale.edu)
  Enterprise Architect 
  Yale University Information Technology Services (ITS)
  25 Science Park, 150 Munson St, New Haven, CT 06520
  Phone:  203 432 6697
  

  
-- 
You are currently subscribed to uportal-dev@lists.ja-sig.org as: arch...@mail-archive.comTo unsubscribe, change settings or access archives, see http://www.ja-sig.org/wiki/display/JSG/uportal-dev