Skip to content

Star character interpreted as bold expression in generated documentation [SPR-12456] #17061

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
spring-projects-issues opened this issue Nov 20, 2014 · 4 comments
Assignees
Labels
status: backported An issue that has been backported to maintenance branches type: documentation A documentation task
Milestone

Comments

@spring-projects-issues
Copy link
Collaborator

Luciano Deriu opened SPR-12456 and commented

There are a few pointcut expressions that aren't valid on the Spring AOP documentation. In the examples section there are these 2 expressions (see ref URL)...

execution(* com.xyz.service..(..))
execution(* com.xyz.service...(..))

I'm just learning Spring AOP so i may be wrong but i think they should be...

execution(* com.xyz.service.*(..))
execution(* com.xyz.service.*.*(..))

Also present in this section...
http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/html/aop.html#aop-advice-before


Affects: 4.0.8, 4.1.2

Reference URL: http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/html/aop.html#aop-pointcuts-examples

Referenced from: commits 0d00b67, a5e2afc

Backported to: 4.0.9

@spring-projects-issues
Copy link
Collaborator Author

Stéphane Nicoll commented

It turns out that the sources are right but the rendering is transforming that part for some reason

* the execution of any method defined in the service package:

[source,java,indent=0]
[subs="verbatim,quotes"]
----
	execution(* com.xyz.service.*.*(..))
----

* the execution of any method defined in the service package or a sub-package:

[source,java,indent=0]
[subs="verbatim,quotes"]
----
	execution(* com.xyz.service..*.*(..))
----

@spring-projects-issues
Copy link
Collaborator Author

Stéphane Nicoll commented

This actually affects other areas of the documentation.

@spring-projects-issues
Copy link
Collaborator Author

Stéphane Nicoll commented

Thanks for the report Luciano!

This helped to identify an issue when we transitioned from docbook to asciidoctor. I have fixed those samples and many more. Please check the SNAPSHOT build of the doc for more details.

@spring-projects-issues
Copy link
Collaborator Author

Luciano Deriu commented

You're welcome. Glad I could contribute in some way! The snapshot looks good.

@spring-projects-issues spring-projects-issues added status: backported An issue that has been backported to maintenance branches type: documentation A documentation task labels Jan 11, 2019
@spring-projects-issues spring-projects-issues added this to the 4.1.3 milestone Jan 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: backported An issue that has been backported to maintenance branches type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

2 participants