Code Monkey home page Code Monkey logo

Comments (6)

markstory avatar markstory commented on September 12, 2024

We could probably separate the see annotation into a separate block like

{ifset $annotations['throws']}
<h6>Throws</h6>
<div class="list">
{foreach $annotations['throws'] as $description}
{$description|annotation:'throws':$method|noescape}<br>
{/foreach}
</div>
{/ifset}

We might be able to use the classUrl filter to make a link? It might get hard if the see tag contains other text though.

from cakephp-api-docs.

othercorey avatar othercorey commented on September 12, 2024

Ok, I'm pretty far off on what's expected/allowed in @see after looking through cakephp source more. It can be pretty much anything. I don't know that we can check for each type well enough to generate an appropriate link.

from cakephp-api-docs.

othercorey avatar othercorey commented on September 12, 2024

Took me a while to figure out where this is in api gen, but looks like the annotation filter is supposed to figure this out for us. Seems there is something causing it to fail.

https://github.com/ApiGen/ApiGen/blob/85290e8086f2f40e4d560de09ffd115466379dc2/packages/Annotation/src/AnnotationSubscriber/SeeUsesCoversAnnotationSubscriber.php#L66-L72

from cakephp-api-docs.

ADmad avatar ADmad commented on September 12, 2024

@othercorey This repo is a fork of an old dev version of ApiGen. The ApiGen project has had a shaky life with development often stalling and restarting (and finally dead now) so we have just stuck with whats working for us in general, except for few issues like you have found.

from cakephp-api-docs.

othercorey avatar othercorey commented on September 12, 2024

I noticed the issue talking about api gen being dead so I completely understand. I thought this would be an easy win, but looks like it isn't :(.

from cakephp-api-docs.

othercorey avatar othercorey commented on September 12, 2024

Short follow up for anyone searching. It seems the attribute filter does generate a URL for a class types, but does not for method types. I actually found an example that contains both.

https://api.cakephp.org/3.7/class-Cake.Database.Query.html#_orWhere

from cakephp-api-docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.