Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.php > #18612 > unrolled thread

phpdoc: @uses and @usesby

Started byfictitious <a@b.invalid>
First post2021-04-26 10:37 +0200
Last post2021-04-27 09:30 +0200
Articles 3 — 1 participant

Back to article view | Back to comp.lang.php

Contents

  phpdoc: @uses and @usesby fictitious <a@b.invalid> - 2021-04-26 10:37 +0200
    Re: phpdoc: @uses and @usesby fictitious <a@b.invalid> - 2021-04-26 12:03 +0200
      Re: phpdoc: @uses and @usesby fictitious <a@b.invalid> - 2021-04-27 09:30 +0200

#18612 — phpdoc: @uses and @usesby

Fromfictitious <a@b.invalid>
Date2021-04-26 10:37 +0200
Subjectphpdoc: @uses and @usesby
Message-ID<s65u4d$1068$1@gioia.aioe.org>
++ cat phpdoc.dist.xml
<?xml version="1.0" encoding="UTF-8" ?>
<phpdocumentor
         configVersion="3"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="https://www.phpdoc.org"
 
xsi:noNamespaceSchemaLocation="https://docs.phpdoc.org/latest/phpdoc.xsd"
 >
     <paths>
         <output>build/api</output>
         <cache>build/cache</cache>
     </paths>
     <version number="3.0.0">
         <api>
             <source dsn=".">
                 <path>src</path>
             </source>
         </api>
     </version>
</phpdocumentor>
++ cat src/uses.php
<?php

class Client {
     /**
      * @uses Server::method2()
      */
     function method1(){}
}

class Server {
     function method2(){}
}
++ phpdoc # making documentation...
++ cd build/api/classes
++ firefox Client.html # OUTPUT: https://pasteboard.co/JZ5l756.png
++ firefox Server.html # OUTPUT: https://pasteboard.co/JZ5mB8t.png

If Server::method2() appears in the Tags -> uses section of Client 
documentation page (https://pasteboard.co/JZ5l756.png),
Client::method1() should appear in the Server documentation page 
(https://pasteboard.co/JZ5mB8t.png).
Why not compare?

[toc] | [next] | [standalone]

#18613

Fromfictitious <a@b.invalid>
Date2021-04-26 12:03 +0200
Message-ID<s6636e$1kkk$1@gioia.aioe.org>
In reply to#18612
Il 26/04/21 10:37, fictitious ha scritto:
> ++ cat phpdoc.dist.xml
> <?xml version="1.0" encoding="UTF-8" ?>
> <phpdocumentor
>          configVersion="3"
>          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
>          xmlns="https://www.phpdoc.org"
> 
> xsi:noNamespaceSchemaLocation="https://docs.phpdoc.org/latest/phpdoc.xsd"
>  >
>      <paths>
>          <output>build/api</output>
>          <cache>build/cache</cache>
>      </paths>
>      <version number="3.0.0">
>          <api>
>              <source dsn=".">
>                  <path>src</path>
>              </source>
>          </api>
>      </version>
> </phpdocumentor>
> ++ cat src/uses.php
> <?php
> 
> class Client {
>      /**
>       * @uses Server::method2()
>       */
>      function method1(){}
> }
> 
> class Server {
>      function method2(){}
> }
> ++ phpdoc # making documentation...
> ++ cd build/api/classes
> ++ firefox Client.html # OUTPUT: https://pasteboard.co/JZ5l756.png
> ++ firefox Server.html # OUTPUT: https://pasteboard.co/JZ5mB8t.png
> 
> If Server::method2() appears in the Tags -> uses section of Client 
> documentation page (https://pasteboard.co/JZ5l756.png),
> Client::method1() should appear in the Server documentation page 
> (https://pasteboard.co/JZ5mB8t.png).
> Why not compare?

Of course hoping to have understood what is written here
https://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.uses.pkg.html

[toc] | [prev] | [next] | [standalone]

#18614

Fromfictitious <a@b.invalid>
Date2021-04-27 09:30 +0200
Message-ID<s68ej9$rjs$1@gioia.aioe.org>
In reply to#18613
Il 26/04/21 12:03, fictitious ha scritto:
> Il 26/04/21 10:37, fictitious ha scritto:
>> ++ cat phpdoc.dist.xml
>> <?xml version="1.0" encoding="UTF-8" ?>
>> <phpdocumentor
>>          configVersion="3"
>>          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
>>          xmlns="https://www.phpdoc.org"
>>
>> xsi:noNamespaceSchemaLocation="https://docs.phpdoc.org/latest/phpdoc.xsd"
>>  >
>>      <paths>
>>          <output>build/api</output>
>>          <cache>build/cache</cache>
>>      </paths>
>>      <version number="3.0.0">
>>          <api>
>>              <source dsn=".">
>>                  <path>src</path>
>>              </source>
>>          </api>
>>      </version>
>> </phpdocumentor>
>> ++ cat src/uses.php
>> <?php
>>
>> class Client {
>>      /**
>>       * @uses Server::method2()
>>       */
>>      function method1(){}
>> }
>>
>> class Server {
>>      function method2(){}
>> }
>> ++ phpdoc # making documentation...
>> ++ cd build/api/classes
>> ++ firefox Client.html # OUTPUT: https://pasteboard.co/JZ5l756.png
>> ++ firefox Server.html # OUTPUT: https://pasteboard.co/JZ5mB8t.png
>>
>> If Server::method2() appears in the Tags -> uses section of Client 
>> documentation page (https://pasteboard.co/JZ5l756.png),
>> Client::method1() should appear in the Server documentation page 
>> (https://pasteboard.co/JZ5mB8t.png).
>> Why not compare?
> 
> Of course hoping to have understood what is written here
> https://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.uses.pkg.html 
> 

Nothing?

[toc] | [prev] | [standalone]

Back to top | Article view | comp.lang.php

csiph-web