lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Koji Sekiguchi (JIRA)" <j...@apache.org>
Subject [jira] Commented: (LUCENE-2894) Use of google-code-prettify for Lucene/Solr Javadoc
Date Wed, 02 Feb 2011 03:26:28 GMT

    [ https://issues.apache.org/jira/browse/LUCENE-2894?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12989503#comment-12989503
] 

Koji Sekiguchi commented on LUCENE-2894:
----------------------------------------

bq. on a related note maybe this would encourage us to add more examples to our javadocs,
which I think is really helpful for users.

I agree.

bq. Any idea what it takes to integrate this with an ant task for javadocs?

Nothing special at this moment. So the author of javadoc should know where prettify script
is:

{code}
<script src="../../../../prettify.js" type="text/javascript"></script>
{code}

He should write it in another javadoc:

{code}
<script src="../../../../../../../prettify.js" type="text/javascript"></script>
{code}

I don't like it...

(where prettify.js needs to be copied from somewhere (dev-tools? for example) to output dir
of javadoc by ant task.)

> Use of google-code-prettify for Lucene/Solr Javadoc
> ---------------------------------------------------
>
>                 Key: LUCENE-2894
>                 URL: https://issues.apache.org/jira/browse/LUCENE-2894
>             Project: Lucene - Java
>          Issue Type: Improvement
>          Components: Javadocs
>            Reporter: Koji Sekiguchi
>            Assignee: Koji Sekiguchi
>            Priority: Minor
>             Fix For: 3.1
>
>
> My company, RONDHUIT uses google-code-prettify (Apache License 2.0) in Javadoc for syntax
highlighting:
> http://www.rondhuit-demo.com/RCSS/api/com/rondhuit/solr/analysis/JaReadingSynonymFilterFactory.html
> I think we can use it for Lucene javadoc (java sample code in overview.html etc) and
Solr javadoc (Analyzer Factories etc) to improve or simplify our life.

-- 
This message is automatically generated by JIRA.
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

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


Mime
View raw message