{"action":"created","issue":{"url":"https://api.github.com/repos/klutometis/roxygen/issues/433","labels_url":"https://api.github.com/repos/klutometis/roxygen/issues/433/labels{/name}","comments_url":"https://api.github.com/repos/klutometis/roxygen/issues/433/comments","events_url":"https://api.github.com/repos/klutometis/roxygen/issues/433/events","html_url":"https://github.com/klutometis/roxygen/issues/433","id":115963874,"number":433,"title":"RC class - weird NAMESPACE","user":{"login":"odinuv","id":4319320,"avatar_url":"https://avatars.githubusercontent.com/u/4319320?v=3","gravatar_id":"","url":"https://api.github.com/users/odinuv","html_url":"https://github.com/odinuv","followers_url":"https://api.github.com/users/odinuv/followers","following_url":"https://api.github.com/users/odinuv/following{/other_user}","gists_url":"https://api.github.com/users/odinuv/gists{/gist_id}","starred_url":"https://api.github.com/users/odinuv/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/odinuv/subscriptions","organizations_url":"https://api.github.com/users/odinuv/orgs","repos_url":"https://api.github.com/users/odinuv/repos","events_url":"https://api.github.com/users/odinuv/events{/privacy}","received_events_url":"https://api.github.com/users/odinuv/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-11-09T20:56:10Z","updated_at":"2015-11-10T09:21:22Z","closed_at":null,"body":"Given the following code\r\n\r\n```\r\n#' test\r\n#' @import methods\r\n#' @exportClass \r\nLGModule <- setRefClass(\r\n    'LGModule',\r\n    methods = list(\r\n       #' some lengthy description\r\n       fooBar = function() {\r\n            NULL    \r\n        }\r\n    )\r\n)\r\n```\r\n\r\nI get a NAMESPACE file:\r\n```\r\n# Generated by roxygen2: do not edit by hand\r\n\r\nexportClasses(description)\r\nexportClasses(lengthy)\r\nexportClasses(some)\r\nimport(methods)\r\n```\r\n\r\nUsing this code:\r\n```\r\n#' test\r\n#' @import methods\r\n#' @export\r\nLGModule <- setRefClass(\r\n    'LGModule',\r\n    methods = list(\r\n       #' some lengthy description\r\n       #' @export\r\n       fooBar = function() {\r\n            NULL    \r\n        }\r\n    )\r\n)\r\n```\r\n\r\ni get a namespace file:\r\n```\r\n# Generated by roxygen2: do not edit by hand\r\n\r\nexport(description)\r\nexport(lengthy)\r\nexport(some)\r\nexportClasses(LGModule)\r\nimport(methods)\r\n```\r\n\r\nJust for reference - this results in errors like: \"classes some, lengthy, description were specified for export but not defined\" or \"Error in namespaceExport(ns, exports) : undefined exports: description, lengthy, some\""},"comment":{"url":"https://api.github.com/repos/klutometis/roxygen/issues/comments/155366190","html_url":"https://github.com/klutometis/roxygen/issues/433#issuecomment-155366190","issue_url":"https://api.github.com/repos/klutometis/roxygen/issues/433","id":155366190,"user":{"login":"krlmlr","id":1741643,"avatar_url":"https://avatars.githubusercontent.com/u/1741643?v=3","gravatar_id":"","url":"https://api.github.com/users/krlmlr","html_url":"https://github.com/krlmlr","followers_url":"https://api.github.com/users/krlmlr/followers","following_url":"https://api.github.com/users/krlmlr/following{/other_user}","gists_url":"https://api.github.com/users/krlmlr/gists{/gist_id}","starred_url":"https://api.github.com/users/krlmlr/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/krlmlr/subscriptions","organizations_url":"https://api.github.com/users/krlmlr/orgs","repos_url":"https://api.github.com/users/krlmlr/repos","events_url":"https://api.github.com/users/krlmlr/events{/privacy}","received_events_url":"https://api.github.com/users/krlmlr/received_events","type":"User","site_admin":false},"created_at":"2015-11-10T09:21:22Z","updated_at":"2015-11-10T09:21:22Z","body":"Your examples are parsed as\r\n\r\n```\r\n#' test\r\n#' @import methods\r\n#' @exportClass \r\n#' some lengthy description\r\nLGModule <- setRefClass(\r\n    'LGModule',\r\n    methods = list(\r\n       fooBar = function() {\r\n            NULL    \r\n        }\r\n    )\r\n)\r\n```\r\n\r\nand\r\n\r\n```\r\n#' test\r\n#' @import methods\r\n#' @export\r\n#' some lengthy description\r\n#' @export\r\nLGModule <- setRefClass(\r\n    'LGModule',\r\n    methods = list(\r\n       fooBar = function() {\r\n            NULL    \r\n        }\r\n    )\r\n)\r\n```\r\n\r\nas of roxygen2 5.0.0. The roxygen-style comments inside the ref class definition are now part of the documentation. If you want to add the description to the documentation, use\r\n\r\n```\r\n#' test\r\n#' @import methods\r\n#' @export\r\nLGModule <- setRefClass(\r\n    'LGModule',\r\n    methods = list(\r\n       #' @details some lengthy description\r\n       fooBar = function() {\r\n            NULL    \r\n        }\r\n    )\r\n)\r\n```\r\n\r\nOtherwise, simply revert to using plain comments:\r\n\r\n```\r\n#' test\r\n#' @import methods\r\n#' @exportClass \r\nLGModule <- setRefClass(\r\n    'LGModule',\r\n    methods = list(\r\n       # some lengthy description\r\n       fooBar = function() {\r\n            NULL    \r\n        }\r\n    )\r\n)\r\n```\r\n\r\nSee also #428 and http://stackoverflow.com/a/33530515/946850."}}