share/nitweb/views/doc/doc.html

   1 <div>
   2         <div class='col-lg-2 col-sm-3 col-xs-12'>
   3                 <ui-summary target='#summary-content' />
   4         </div>
   5         <div class='col-lg-10 col-sm-9 col-xs-12' id='summary-content' ng-class='{
   6                 "col-lg-8 col-sm-6 col-xs-12": vm.mentity.class_name == "MPackage"
   7         }'>
   8                 <div class='card'>
   9                         <div class='card-body'>
  10                                 <div ng-if='vm.doc'>
  11                                         <div ng-bind-html='vm.doc.documentation'></div>
  12                                 </div>
  13                                 <div ng-if='!vm.doc'>
  14                                         <i class='text-muted'>No documentation for this entity.</i>
  15                                 </div>
  16                         </div>
  17                 </div>
  18
  19                 <entity-list list-title='Introduced classes' list-entities='vm.mentity.intro_mclasses'
  20                         list-object-filter='{}' />
  21
  22                 <entity-list list-title='Class redefinitions' list-entities='vm.mentity.redef_mclassdefs'
  23                         list-object-filter='{}' />
  24
  25                 <entity-list list-title='Constructors'
  26                         list-entities='vm.mentity.all_mproperties'
  27                         list-object-filter='{is_init: true}' />
  28
  29                 <entity-list list-title='Introduced properties'
  30                         list-entities='vm.mentity.intro_mproperties'
  31                         list-object-filter='{is_init: "!true"}' />
  32
  33                 <entity-list list-title='Redefined properties'
  34                         list-entities='vm.mentity.redef_mproperties'
  35                         list-object-filter='{is_init: "!true"}' />
  36
  37         </div>
  38
  39         <div class='col-lg-2 col-sm-3 col-xs-12' ng-class='{
  40                 "hidden": vm.mentity.class_name != "MPackage"
  41         }'>
  42                 <br>
  43                 <p ng-repeat='maintainer in vm.mentity.metadata.maintainers' class='lead'>
  44                         <img class='avatar' src='https://secure.gravatar.com/avatar/{{maintainer.gravatar}}?size=20&default=retro' />
  45                         <span>
  46                                 <a ui-sref='person({id: maintainer.name})'>{{maintainer.name}}</a>
  47                         </span>
  48                         <br>
  49                 </p>
  50                 <span ng-if='vm.mentity.metadata.license'>
  51                         <span class='text-muted'>
  52                                 <a href='http://opensource.org/licenses/{{vm.mentity.metadata.license}}'>{{vm.mentity.metadata.license}}</a>
  53                                 license
  54                         </span>
  55                         <br>
  56                 </span>
  57
  58                 <div ng-if='vm.mentity.metadata.homepage || vm.mentity.metadata.issues'>
  59                         <h3>Links</h3>
  60                         <ul class='list-unstyled'>
  61                                 <li ng-if='vm.mentity.metadata.homepage'>
  62                                         <a href='{{vm.mentity.metadata.homepage}}'>Homepage</a>
  63                                 </li>
  64                                 <li ng-if='vm.mentity.metadata.browse'>
  65                                         <a href='{{vm.mentity.metadata.browse}}'>Source Code</a>
  66                                 </li>
  67                                 <li ng-if='vm.mentity.metadata.issues'>
  68                                         <a href='{{vm.mentity.metadata.issues}}'>Issues</a>
  69                                 </li>
  70                         </ul>
  71                 </div>
  72
  73                 <div ng-if='vm.mentity.metadata.git || vm.mentity.stats.commits'>
  74                         <h3>Git</h3>
  75                         <ul class='list-unstyled' style='white-space: nowrap; overflow: hidden; text-overflow: ellipsis;'>
  76                                 <li ng-if='vm.mentity.metadata.git'>
  77                                         <a href='{{vm.mentity.metadata.git}}'>{{vm.mentity.metadata.git}}</a>
  78                                 </li>
  79                                 <li ng-if='vm.mentity.stats.commits' class='text-muted'>
  80                                         <br><b>{{vm.mentity.stats.commits}} commits</b>
  81                                 </li>
  82                                 <li ng-if='vm.mentity.metadata.last_date'><b class='text-muted'>Last:</b> {{vm.date(vm.mentity.metadata.last_date) | date: 'medium'}}</li>
  83                                 <li ng-if='vm.mentity.metadata.first_date'><b class='text-muted'>First: </b>{{vm.date(vm.mentity.metadata.first_date) | date: 'medium'}}</li>
  84                         </ul>
  85                 </div>
  86
  87                 <div ng-if='vm.mentity.stats'>
  88                         <h3>Quality</h3>
  89                         <ul class='list-unstyled'>
  90                                 <li ng-if='vm.mentity.stats.documentation_score'>
  91                                         {{vm.mentity.stats.documentation_score}}% documented
  92                                 </li>
  93                                 <li ng-if='vm.mentity.stats.errors' class='text-danger'>
  94                                         {{vm.mentity.stats.errors}} errors
  95                                 </li>
  96                                 <li ng-if='vm.mentity.stats.warnings' class='text-warning'>
  97                                         {{vm.mentity.stats.warnings}} warnings
  98                                         ({{vm.mentity.stats.warnings_per_kloc}} / kloc)
  99                                 </li>
 100                         </ul>
 101                 </div>
 102
 103                 <div ng-if='vm.mentity.metadata.tags.length > 0'>
 104                         <h3>Tags</h3>
 105                         <span ng-repeat='tag in vm.mentity.metadata.tags'>
 106                                 <a ui-sref='tag({id: tag})'>{{tag}}</a><span ng-if='!$last'>,</span>
 107                         </span>
 108                 </div>
 109
 110                 <div ng-if='vm.mentity.dependencies.length > 0'>
 111                         <h3>Requirements</h3>
 112                         <span ng-repeat='parent in vm.mentity.dependencies'>
 113                                 <a ui-sref='mentity({id: parent.name})' title='{{parent.synopsis}}'>{{parent.name}}</a><span ng-if='!$last'>,</span>
 114                         </span>
 115                 </div>
 116
 117                 <div ng-if='vm.mentity.clients.length > 0'>
 118                         <h3>Clients</h3>
 119                         <span ng-repeat='client in vm.mentity.clients'>
 120                                 <a ui-sref='mentity({id: client.name})' title='{{client.synopsis}}'>{{client.name}}</a><span ng-if='!$last'>,</span>
 121                         </span>
 122                 </div>
 123
 124                 <div ng-if='vm.mentity.metadata.contributors.length > 1'>
 125                         <h3>Contributors</h3>
 126                         <ul class='list-unstyled'>
 127                                 <li ng-repeat='contributor in vm.mentity.metadata.contributors'>
 128                                         <img class='avatar' src='https://secure.gravatar.com/avatar/{{contributor.gravatar}}?size=20&default=retro' />
 129                                         <a ui-sref='person({id: contributor.name})'>
 130                                         {{contributor.name}}</a>
 131                                 </li>
 132                         </ul>
 133                 </div>
 134
 135                 <div ng-if='vm.mentity.stats'>
 136                         <h3>Stats</h3>
 137                         <ul class='list-unstyled'>
 138                                 <li>{{vm.mentity.stats.mmodules}} modules</li>
 139                                 <li>{{vm.mentity.stats.mclasses}} classes</li>
 140                                 <li>{{vm.mentity.stats.mmethods}} methods</li>
 141                                 <li>{{vm.mentity.stats.loc}} loc</li>
 142                         </ul>
 143                 </div>
 144         </div>
 145 </div>