You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ds...@apache.org on 2012/09/10 05:32:03 UTC

svn commit: r1382633 - /lucene/dev/trunk/lucene/spatial/src/java/overview.html

Author: dsmiley
Date: Mon Sep 10 03:32:02 2012
New Revision: 1382633

URL: http://svn.apache.org/viewvc?rev=1382633&view=rev
Log:
Removed helpful link to SpatialExample.java source code in svn.  The build policy forbids it :-(

Modified:
    lucene/dev/trunk/lucene/spatial/src/java/overview.html

Modified: lucene/dev/trunk/lucene/spatial/src/java/overview.html
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/spatial/src/java/overview.html?rev=1382633&r1=1382632&r2=1382633&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/spatial/src/java/overview.html (original)
+++ lucene/dev/trunk/lucene/spatial/src/java/overview.html Mon Sep 10 03:32:02 2012
@@ -33,8 +33,7 @@
   </p>
   <p>
     For some sample code showing how to use the API, see
-    <a href="http://svn.apache.org/repos/asf/lucene/dev/trunk/lucene/spatial/src/test/org/apache/lucene/spatial/SpatialExample.java">
-      SpatialExample.java</a> in the tests.
+      SpatialExample.java in the tests.
   </p>
   <p>
     The spatial module uses

RE: svn commit: r1382633 - /lucene/dev/trunk/lucene/spatial/src/java/overview.html

Posted by Uwe Schindler <uw...@thetaphi.de>.
+1 to move *all* example code to one module (the demo module)!

-----
Uwe Schindler
H.-H.-Meier-Allee 63, D-28213 Bremen
http://www.thetaphi.de
eMail: uwe@thetaphi.de


> -----Original Message-----
> From: Robert Muir [mailto:rcmuir@gmail.com]
> Sent: Monday, September 10, 2012 7:35 PM
> To: dev@lucene.apache.org
> Subject: Re: svn commit: r1382633 -
> /lucene/dev/trunk/lucene/spatial/src/java/overview.html
> 
> On Mon, Sep 10, 2012 at 1:32 PM, Uwe Schindler <uw...@thetaphi.de> wrote:
> > The trick is this option in build.xml:
> >     <invoke-module-javadoc linksource="yes">
> >
> > After that you can refer to source code of all classes via src-html folder.
> Unfortunately, this creates source file html for all java classes, not only
> referenced ones. For demo this was not a problem, as there are only 3 .java
> files. This option also makes all method declarations in javadocs "hot" pointing
> to the source code line. Again very nice for demo code...
> >
> 
> right, I was thinking if we actually consolidated our examples (facets, spatial,
> whatever) into this demo module then this option would make sense.
> 
> --
> lucidworks.com
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org For additional
> commands, e-mail: dev-help@lucene.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org

Re: svn commit: r1382633 - /lucene/dev/trunk/lucene/spatial/src/java/overview.html

Posted by Robert Muir <rc...@gmail.com>.
On Mon, Sep 10, 2012 at 1:32 PM, Uwe Schindler <uw...@thetaphi.de> wrote:
> The trick is this option in build.xml:
>     <invoke-module-javadoc linksource="yes">
>
> After that you can refer to source code of all classes via src-html folder. Unfortunately, this creates source file html for all java classes, not only referenced ones. For demo this was not a problem, as there are only 3 .java files. This option also makes all method declarations in javadocs "hot" pointing to the source code line. Again very nice for demo code...
>

right, I was thinking if we actually consolidated our examples
(facets, spatial, whatever) into this demo module then this option
would make sense.

-- 
lucidworks.com

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org

RE: svn commit: r1382633 - /lucene/dev/trunk/lucene/spatial/src/java/overview.html

Posted by Uwe Schindler <uw...@thetaphi.de>.
The trick is this option in build.xml:
    <invoke-module-javadoc linksource="yes">

After that you can refer to source code of all classes via src-html folder. Unfortunately, this creates source file html for all java classes, not only referenced ones. For demo this was not a problem, as there are only 3 .java files. This option also makes all method declarations in javadocs "hot" pointing to the source code line. Again very nice for demo code...

Uwe

-----
Uwe Schindler
H.-H.-Meier-Allee 63, D-28213 Bremen
http://www.thetaphi.de
eMail: uwe@thetaphi.de


> -----Original Message-----
> From: Robert Muir [mailto:rcmuir@gmail.com]
> Sent: Monday, September 10, 2012 6:37 PM
> To: dev@lucene.apache.org
> Subject: Re: svn commit: r1382633 -
> /lucene/dev/trunk/lucene/spatial/src/java/overview.html
> 
> On Mon, Sep 10, 2012 at 12:23 PM, Smiley, David W. <ds...@mitre.org>
> wrote:
> > I figured that is why the decision was made.  I think exceptions can be made
> as long as one understands the down side.  An alternative solution to this
> decision is to simply make sure the URL doesn't 404.
> >
> 
> The issue in general is that the docs are 'versioned' so it could be ok now, and
> we could release 4.0, and then the 4.0 docs are later broken by API changes,
> code movements, etc.
> 
> Separately there was a recent thread about examples (Dawid Weiss responded
> with some ideas they used in carrotsearch): I still feel we need to do some work
> here.
> 
> The demo module links in its 'examples' into the javadocs with a javadoc option
> (http://lucene.apache.org/core/4_0_0-BETA/demo/overview-
> summary.html#Location_of_the_source),
> so thats one way to do it. Dawid had a different idea that would also work I
> think.
> 
> --
> lucidworks.com
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org For additional
> commands, e-mail: dev-help@lucene.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org

Re: svn commit: r1382633 - /lucene/dev/trunk/lucene/spatial/src/java/overview.html

Posted by Robert Muir <rc...@gmail.com>.
On Mon, Sep 10, 2012 at 12:23 PM, Smiley, David W. <ds...@mitre.org> wrote:
> I figured that is why the decision was made.  I think exceptions can be made as long as one understands the down side.  An alternative solution to this decision is to simply make sure the URL doesn't 404.
>

The issue in general is that the docs are 'versioned' so it could be
ok now, and we could release 4.0, and then the 4.0 docs are later
broken by API changes, code movements, etc.

Separately there was a recent thread about examples (Dawid Weiss
responded with some ideas they used in carrotsearch): I still feel we
need to do some work here.

The demo module links in its 'examples' into the javadocs with a
javadoc option (http://lucene.apache.org/core/4_0_0-BETA/demo/overview-summary.html#Location_of_the_source),
so thats one way to do it. Dawid had a different idea that would also
work I think.

-- 
lucidworks.com

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org

Re: svn commit: r1382633 - /lucene/dev/trunk/lucene/spatial/src/java/overview.html

Posted by "Smiley, David W." <ds...@mitre.org>.
I figured that is why the decision was made.  I think exceptions can be made as long as one understands the down side.  An alternative solution to this decision is to simply make sure the URL doesn't 404.

~ David

On Sep 10, 2012, at 7:08 AM, Michael McCandless wrote:

> On Sun, Sep 9, 2012 at 11:32 PM,  <ds...@apache.org> wrote:
> 
>> Removed helpful link to SpatialExample.java source code in svn.  The build policy forbids it :-(
> 
> Linking into SVN trunk is dangerous: when we release, the released
> javadocs will then have a link to SVN trunk which of course changes
> over time.  So then if we update APIs, or refactor or move this source
> to a new location, the link is wrong/broken.
> 
> Mike McCandless
> 
> http://blog.mikemccandless.com
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: dev-help@lucene.apache.org
> 


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org

Re: svn commit: r1382633 - /lucene/dev/trunk/lucene/spatial/src/java/overview.html

Posted by Michael McCandless <lu...@mikemccandless.com>.
On Sun, Sep 9, 2012 at 11:32 PM,  <ds...@apache.org> wrote:

> Removed helpful link to SpatialExample.java source code in svn.  The build policy forbids it :-(

Linking into SVN trunk is dangerous: when we release, the released
javadocs will then have a link to SVN trunk which of course changes
over time.  So then if we update APIs, or refactor or move this source
to a new location, the link is wrong/broken.

Mike McCandless

http://blog.mikemccandless.com

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org