Return-Path: 
 <dev-return-64306-apmail-lucene-dev-archive=lucene.apache.org@lucene.apache.org>
Delivered-To: apmail-lucene-dev-archive@www.apache.org
Received: (qmail 10389 invoked from network); 2 Feb 2011 11:45:55 -0000
Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.3)
  by minotaur.apache.org with SMTP; 2 Feb 2011 11:45:55 -0000
Received: (qmail 70551 invoked by uid 500); 2 Feb 2011 11:45:54 -0000
Delivered-To: apmail-lucene-dev-archive@lucene.apache.org
Received: (qmail 70110 invoked by uid 500); 2 Feb 2011 11:45:51 -0000
Mailing-List: contact dev-help@lucene.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:dev-help@lucene.apache.org>
List-Unsubscribe: <mailto:dev-unsubscribe@lucene.apache.org>
List-Post: <mailto:dev@lucene.apache.org>
List-Id: <dev.lucene.apache.org>
Reply-To: dev@lucene.apache.org
Delivered-To: mailing list dev@lucene.apache.org
Received: (qmail 70103 invoked by uid 99); 2 Feb 2011 11:45:50 -0000
Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136)
    by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 02 Feb 2011 11:45:50 +0000
X-ASF-Spam-Status: No, hits=-2000.0 required=5.0
	tests=ALL_TRUSTED,T_FRT_ADULT2,T_RP_MATCHES_RCVD
X-Spam-Check-By: apache.org
Received: from [140.211.11.116] (HELO hel.zones.apache.org) (140.211.11.116)
    by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 02 Feb 2011 11:45:50 +0000
Received: from hel.zones.apache.org (hel.zones.apache.org [140.211.11.116])
	by hel.zones.apache.org (Postfix) with ESMTP id 0F1C5187FEA
	for <dev@lucene.apache.org>; Wed,  2 Feb 2011 11:45:30 +0000 (UTC)
Date: Wed, 2 Feb 2011 11:45:30 +0000 (UTC)
From: "Koji Sekiguchi (JIRA)" <jira@apache.org>
To: dev@lucene.apache.org
Message-ID: 
 <559188173.4884.1296647130058.JavaMail.tomcat@hel.zones.apache.org>
In-Reply-To: <20848161.230971296098323832.JavaMail.jira@thor>
Subject: [jira] Updated: (LUCENE-2894) Use of google-code-prettify for
 Lucene/Solr Javadoc
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394


     [ https://issues.apache.org/jira/browse/LUCENE-2894?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Koji Sekiguchi updated LUCENE-2894:
-----------------------------------

    Attachment: LUCENE-2894.patch

First draft for the review. Try ant clean javadoc-core under solr directory and see StopFilterFactory javadoc.

In this draft, I used @{docRoot} (thanks Hoss!), and wrote the following lines in javadoc comment:

{code}
<script src="{@docRoot}/prettify/prettify.js" type="text/javascript"></script>
<script language="JavaScript">window.onload=function(){windowTitle();prettyPrint();}</script>
{code}

but, they probably can be omitted if "-header" option as Hoss mentioned.

> 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
>
>         Attachments: LUCENE-2894.patch
>
>
> 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