You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@isis.apache.org by "Daniel Keir Haywood (Jira)" <ji...@apache.org> on 2021/02/04 07:20:00 UTC
[jira] [Updated] (ISIS-2526) Tooling: suppress header, use filename
in caption
[ https://issues.apache.org/jira/browse/ISIS-2526?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Daniel Keir Haywood updated ISIS-2526:
--------------------------------------
Description:
The generated index includes a header, but that makes it tricky to include.
For example, this source:
!image-2021-02-04-06-59-48-038.png|width=533,height=113!
Renders as folows:
!image-2021-02-04-06-59-18-608.png|width=327,height=165!
I think that the "AcceptHeaderService : interface" is unnecessary (there would normally be a paragraph here anyway if there was some javadoc for the class).
It would be nice though to use the class as a caption:
{code:java}
[source,java]
.AcceptHeaderService.java
----
public interface AcceptHeaderService {
...
}
----{code}
*Extending the idea...*
I think it might be useful to include "API" as a section, but *after* the top-level paragraph.
In other words, the generated file would be:
{code:java}
The paragraph(s) taken from the javadoc of the class interface.
There might be quite a lot of text here.
= API
[source,java]
.AcceptHeaderService.java
----
public interface AcceptHeaderService {
...
}
----
{code}
These generated files will then be included quite nicely into the refguide pages.
was:
The generated index includes a header, but that makes it tricky to include.
For example, this source:
!image-2021-02-04-06-59-48-038.png|width=533,height=113!
Renders as folows:
!image-2021-02-04-06-59-18-608.png|width=327,height=165!
I think that the "AcceptHeaderService : interface" is unnecessary (there would normally be a paragraph here anyway if there was some javadoc for the class).
It would be nice though to use the class as a caption:
{code:java}
[source,java]
.AcceptHeaderService.java
----
public interface AcceptHeaderService {
...
}
----{code}
> Tooling: suppress header, use filename in caption
> -------------------------------------------------
>
> Key: ISIS-2526
> URL: https://issues.apache.org/jira/browse/ISIS-2526
> Project: Isis
> Issue Type: Improvement
> Components: Isis Docs & Website
> Reporter: Daniel Keir Haywood
> Assignee: Andi Huber
> Priority: Major
> Fix For: 2.0.0-M5
>
> Attachments: image-2021-02-04-06-59-18-608.png, image-2021-02-04-06-59-48-038.png
>
>
> The generated index includes a header, but that makes it tricky to include.
> For example, this source:
> !image-2021-02-04-06-59-48-038.png|width=533,height=113!
>
> Renders as folows:
> !image-2021-02-04-06-59-18-608.png|width=327,height=165!
>
> I think that the "AcceptHeaderService : interface" is unnecessary (there would normally be a paragraph here anyway if there was some javadoc for the class).
> It would be nice though to use the class as a caption:
> {code:java}
> [source,java]
> .AcceptHeaderService.java
> ----
> public interface AcceptHeaderService {
> ...
> }
> ----{code}
>
> *Extending the idea...*
> I think it might be useful to include "API" as a section, but *after* the top-level paragraph.
> In other words, the generated file would be:
> {code:java}
> The paragraph(s) taken from the javadoc of the class interface.
> There might be quite a lot of text here.
> = API
> [source,java]
> .AcceptHeaderService.java
> ----
> public interface AcceptHeaderService {
> ...
> }
> ----
> {code}
>
> These generated files will then be included quite nicely into the refguide pages.
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)