SCM

SCM Repository

[inlinedocs] Diff of /pkg/inlinedocs/R/parsers.R
ViewVC logotype

Diff of /pkg/inlinedocs/R/parsers.R

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 392, Tue Sep 3 07:46:16 2013 UTC revision 393, Tue Oct 1 07:15:26 2013 UTC
# Line 586  Line 586 
586               }               }
587               ## Eliminate leading and trailing code               ## Eliminate leading and trailing code
588               ex <- ex[-c(1, length(ex))]               ex <- ex[-c(1, length(ex))]
589                 if( length(ex) ){  # avoid error on yet empty example
590               if(ex[1]=="{")ex <- ex[-1]               if(ex[1]=="{")ex <- ex[-1]
591               ## all the prefixes               ## all the prefixes
592               ex <- kill.prefix.whitespace(ex)               ex <- kill.prefix.whitespace(ex)
593                 }
594               ## Add an empty line before and after example               ## Add an empty line before and after example
595               ex <- c("", ex, "")               ex <- c("", ex, "")
596             }             }
# Line 640  Line 642 
642    extract.docs.try <- function(o,on)    extract.docs.try <- function(o,on)
643      {      {
644        ## Note: we could use parsed information here too, but that        ## Note: we could use parsed information here too, but that
645        ## would produce different results for setMethodS3 etc.        ## would produce different results for R.methodsS3::setMethodS3 etc.
646        doc <- list()        doc <- list()
647        if ( !is.null(parsed[[on]]) ){        if ( !is.null(parsed[[on]]) ){
648          if ( !is.na(parsed[[on]]@code[1]) ){ # no code given for generics          if ( !is.na(parsed[[on]]@code[1]) ){ # no code given for generics
# Line 649  Line 651 
651          if(!"description"%in%names(doc) && !is.na(parsed[[on]]@description) ){          if(!"description"%in%names(doc) && !is.na(parsed[[on]]@description) ){
652            doc$description <- parsed[[on]]@description            doc$description <- parsed[[on]]@description
653          }          }
654          ## if ( "setMethodS3" == parsed[[on]]@created ){          ## if ( "R.methodsS3::setMethodS3" == parsed[[on]]@created ){
655          ##   gen <- leadingS3generic(on,topenv())          ##   gen <- leadingS3generic(on,topenv())
656          ##   if ( 0 < length(gen) ){          ##   if ( 0 < length(gen) ){
657          ##     doc$.s3method <- gen$.s3method          ##     doc$.s3method <- gen$.s3method
# Line 765  Line 767 
767  ### Using the base \code{parse} function, analyse the file to link  ### Using the base \code{parse} function, analyse the file to link
768  ### preceding "prefix" comments to each active chunk. Those comments form  ### preceding "prefix" comments to each active chunk. Those comments form
769  ### the default description for that chunk. The analysis also looks for  ### the default description for that chunk. The analysis also looks for
770  ### S4 class "setClass" calls and R.oo setConstructorS3 and setMethodS3  ### S4 class "setClass" calls and R.oo setConstructorS3 and R.methodsS3::setMethodS3
771  ### calls in order to link the documentation of those properly.  ### calls in order to link the documentation of those properly.
772  (code  (code
773  ### Lines of R source code in a character vector - note that any  ### Lines of R source code in a character vector - note that any
# Line 801  Line 803 
803      ## \item{assignment (<-)}{Ordinary assignment of value/function;}      ## \item{assignment (<-)}{Ordinary assignment of value/function;}
804      ## \item{setClass}{Definition of S4 class;}      ## \item{setClass}{Definition of S4 class;}
805      ## \item{setConstructorS3}{Definition of S3 class using R.oo package;}      ## \item{setConstructorS3}{Definition of S3 class using R.oo package;}
806      ## \item{setMethodS3}{Definition of method for S3 class using R.oo package.}}      ## \item{R.methodsS3::setMethodS3}{Definition of method for S3 class using R.oo package.}}
807      ## Additionally, the value may be a name of a function defined elsewhere,      ## Additionally, the value may be a name of a function defined elsewhere,
808      ## in which case the documentation should be copied from that other definition.      ## in which case the documentation should be copied from that other definition.
809      ## This is handled using the concept of documentation links.      ## This is handled using the concept of documentation links.
# Line 823  Line 825 
825                                  parent=parent,                                  parent=parent,
826                                  code=paste(chunks[[k]],sep=""),                                  code=paste(chunks[[k]],sep=""),
827                                  description=default.description)                                  description=default.description)
828      } else if ( expr.type == "setMethodS3" || expr.type ==  "R.methodsS3::setMethodS3"){      } else if ( expr.type == "R.methodsS3::setMethodS3" || expr.type ==  "R.methodsS3::R.methodsS3::setMethodS3"){
829        ##details<< The \code{setMethodS3} calls introduce additional        ##details<< The \code{R.methodsS3::setMethodS3} calls introduce additional
830        ## complexity: they will define an additional S3 generic (which        ## complexity: they will define an additional S3 generic (which
831        ## needs documentation to avoid warnings at package build time)        ## needs documentation to avoid warnings at package build time)
832        ## unless one already exists. This also is handled by "linking"        ## unless one already exists. This also is handled by "linking"

Legend:
Removed from v.392  
changed lines
  Added in v.393

root@r-forge.r-project.org
ViewVC Help
Powered by ViewVC 1.0.0  
Thanks to:
Vienna University of Economics and Business University of Wisconsin - Madison Powered By FusionForge